BreachDirectory ∙ API Dokumentacija

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 Jums padėti netapti sekančia įsilaužėlių auka. Visi gali naudoti API - gavę prieigą prie API Jūs galėsite inkorporuoti mūsų paieškos sistemą į bet kokią informacinę sistemą.

Naudojimasis

API galite panaudoti šitaip: https://BreachDirectory.com/api_usage?method=$Metodas&key=$Raktas&query=$Užklausa
  • $Domenas - Jūsų svetainės domenas (šiuo metu pateikti svetainės domeno nebereikia - ši funkcija vėliau gali būti įdiegta iš naujo.);
  • $Metodas - Paieškos metodas (šiuo metu prieinami šie metodai - domeno ("domain"), el.pašto ("email"), vartotojų vardų ("username") ir IP adresų ("ip");
  • $Raktas - API Raktas, gautas nusipirkus prieigą prie API.
  • $Užklausa - Paieškos užklausa.
  • Visi vartotojai turėtų naudotis šia paslauga tik norėdami pagerinti savo produktų ar paslaugų saugumą. Taip pat privaloma apsaugoti savo API duomenis ir užtikrinti, kad bet kokia informacija, gauta per BreachDirectory (API ar bet kokias kitas susijusias paslaugas) būtų apsaugota nuo neteisėtos prieigos. Visi vartotojai taip pat privalo laikytis visų įstatymų, susijusių su jų jurisdikcija.
    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;
    A search method is required.
    kai nenurodytas paieškos metodas;
    Invalid or Expired API Key.
    kai API raktas neteisingas arba jo galiojimo laikas baigėsi;Arba
    false
    arba tuščias masyvas
    []
    kai paieška negrąžino jokių rezultatų.