BreachDirectory ∙ API

Projektą palaiko:  

API

Daug įmonių vien 2018 m. gavo šimtamilijonines baudas dėl patirtų įsilaužimų. Dabar, įsigaliojus ES bendrajam duomenų apsaugos reglamentui (GDPR), baudos gali būti dar didesnės.
Mūsų API gali Jūsų kompanijai padėti netapti sekančia įsilaužėlių auka. Gavę prieigą prie API rakto Jūs galėsite inkorporuoti mūsų paieškos sistemą į savo svetainę.

Naudojimasis

Vienam domenui išduodamas tik vienas API raktas.
Gavę API raktą, jį galite panaudoti šitaip: https://BreachDirectory.com/api_usage?domain=$Domenas&api_key=$Raktas&method=$Metodas&query=$Užklausa
  • $Domenas - Jūsų svetainės domenas, kurį priskyrėte savo paskyrai per vartotojo kontrolės panelę;
  • $Raktas - API raktas, kurį gavote iš mūsų;
  • $Metodas - Paieškos metodas (šiuo metu prieinami šie metodai - domeno ("domain"), el.pašto ("email"), vartotojų vardų ("username") ir IP adresų ("ip");
  • $Užklausa - Paieškos užklausa.
  • Jei įrašas bus rastas mūsų duomenų bazėje, mes grąžinsime JSON formos "200 OK" atsakymą, kuris atrodys šitaip (viena atsakymo dalis skirta įrašui, esančiam įsilaužime, kita - informacijai apie įsilaužimą):
    [
        {
            "title": "Test Data Breach",
    		"domain": "test.com",
            "email": "[email protected]",
            "username": "Username",
    		"ip": "127.0.0.1"
        }
    	{
    		"id": "ID",
    		"title": "test.com",
    		"domain": "test.com",
    		"breachdate_en": "0000",
    		"breachdate_ru": "0000",
    		"breachdate_lt": "0000",
    		"category_en": "Category",
    		"category_ru": "Категория",
    		"category_lt": "Kategorija",
    		"description_en": "Description",
    		"description_ru": "Описание",
    		"description_lt": "Aprašymas",
    		"compromised_data_en": "Compromised data",
    		"compromised_data_ru": "Скомпрометированные данные",
    		"compromised_data_lt": "Duomenys pavojuje",
    		"verified": "0 / 1",
    		"analyzed": "0 / 1",
    		"analysis_url_en": "Analysis URL",
    		"analysis_url_ru": "URL анализа",
    		"analysis_url_lt": "Analizės nuoroda",
    		"image": "Image"
    	}
    ]

    Klaidų žinutės

    Jei paieška nepavyksta, grąžiname žinutes, pranešančias apie klaidas. Kai kurios iš jų yra:
    A domain is required.
    kai API yra naudojamas ant domeno, kuris nėra autorizuotas;
    An API key is required.
    kai Jūsų naudojamo API rakto nėra mūsų duomenų bazėje arba jo galiojimo laikas baigėsi;
    A search method is required.
    kai nenurodytas paieškos metodas;
    false
    kai paieška negrąžino jokių rezultatų.