Naše API je rychlé a snadno integrovatelné — můžete ho spustit během méně než 15 minut. Navíc získáte 50 bezplatných požadavků denně na začátek.
Všechny API požadavky musí být odesílány metodou POST. Základní endpoint pro všechny požadavky je:
https://numvalid.com/api/v1/[api_key]
Nahraďte [api_key] svým osobním API klíčem. Všechny parametry požadavku musí být odeslány v těle requestu ve formátu JSON. API klíč můžete získat po registraci ve svém dashboardu.
Metoda: test
Tato metoda slouží k otestování připojení k API. Ověřuje, že váš API klíč je platný a že je služba dostupná. Pokud je vše správně nastaveno, API vrátí úspěšnou odpověď.
Příklad požadavku
{
"method": "test"
}Úspěšná odpověď
{
"error": 0,
"message": "Yippee-ki-yay"
}
Pole odpovědi
error — chybový kód (0 znamená úspěšný požadavek)
message — odpověď z API
Metoda: info
Metoda info vrací informace o vašem účtu a aktuálním předplatném, včetně počtu využitých API požadavků.
Příklad požadavku
{
"method": "info"
}Úspěšná odpověď
{
"error": 0,
"name": "John",
"surname": "Smith",
"email": "[email protected]",
"subscription": "Growth",
"count_request": 2349
}
Pole odpovědi
error — chybový kód (0 znamená úspěšný požadavek)
name — křestní jméno majitele účtu
surname — příjmení majitele účtu
email — e-mailová adresa účtu
subscription — aktuální tarif předplatného
count_request — počet API požadavků využitých v aktuálním období předplatného
Metoda: verify
Metoda verify kontroluje telefonní číslo a vrací detailní validační informace.
Telefonní čísla mohou být zadána v libovolném formátu. API automaticky zpracuje znaky jako (, ), -, + a mezery.
Příklad požadavku
{
"phone": "491609502065",
"method": "verify"
}Úspěšná odpověď
{
"error": 0,
"request_phone": "491609502065",
"valid_phone": true,
"type": "mobile",
"format": {
"local": "01609502065",
"international": "+491609502065"
},
"country": {
"code": "DE",
"name": "Germany (Federal Republic of)",
"prefix": "+49"
},
"requests": {
"subscription": "Growth",
"count": 2,
"start": "2026-04-06 10:29:40",
"finish": "2026-10-06 10:29:40",
"limit": 9000
}
}
Pole odpovědi
error — chybový kód (0 znamená úspěšný požadavek)
request_phone — telefonní číslo odeslané v požadavku
valid_phone — výsledek validace (true pokud je číslo platné)
type — typ telefonního čísla (např. mobilní, pevná linka atd.)
Objekt Formát
local — telefonní číslo v lokálním formátu
international — telefonní číslo v mezinárodním formátu
Objekt Země
code — ISO kód země
name — název země
prefix — mezinárodní předvolba
Objekt Požadavky
Informace o aktuálním využití předplatného.
subscription — aktivní tarif předplatného
count — počet již využitých požadavků
start — datum začátku období předplatného
finish — datum konce období předplatného
limit — maximální počet požadavků povolených v období předplatného
Máte otázky k naší API dokumentaci? Kontaktujte nás: