API dokumentace
API klíč
Dostupné metody
Metoda | URL | Popis | Parametry |
---|---|---|---|
GET/POST | /api/v1/phone/validate |
Ověření čísla | phone , country , api_key |
Parametry:
Parametr | Popis | Příklad | Povinný |
---|---|---|---|
api_key |
API klíč | your_key |
Ano |
phone |
Telefonní číslo | +393201234567 |
Ano |
country |
Kód země | IT , ["IT","US","DE"] |
Ne |
Práce s více zeměmi
Parametr country
podporuje několik formátů:
- Jedna země:
IT
- Více zemí oddělených čárkou:
IT,US,DE
- Více zemí oddělených středníkem:
IT;US;DE
- Více zemí oddělených mezerou:
IT US DE
- Pole zemí (POST):
["IT", "US", "DE"]
API se pokouší analyzovat číslo s každou zemí postupně, dokud nenajde platný výsledek. To je užitečné zejména pro čísla v národním formátu.
Kódy odpovědí
Kód | Popis | Příklad |
---|---|---|
200 | Úspěšný požadavek |
|
400 | Neplatný požadavek (chyba v parametrech) |
|
401 | Neautorizováno (neplatný nebo chybějící API klíč) |
|
403 | Přístup zakázán (bez oprávnění nebo zablokováno) |
|
404 | Metoda nebo zdroj nenalezen |
|
429 | Překročen limit požadavků |
|
500 | Vnitřní chyba serveru |
|
Testovací API klíč:
Pokud použijete tento klíč v požadavcích, API vždy vrátí demonstrační (mock) odpověď.
Zůstatek se neodečítá, skutečné kontroly se neprovádějí.
Příklad:
test
Pokud použijete tento klíč v požadavcích, API vždy vrátí demonstrační (mock) odpověď.
Zůstatek se neodečítá, skutečné kontroly se neprovádějí.
Příklad:
curl "https://numlook.ru/api/v1/phone/validate?phone=+393201234567&api_key=test"
Příklady použití
cURL příkazy
Validace čísla:
cURL
curl "https://numlook.ru/api/v1/phone/validate?phone=+393201234567&api_key=your_key"
S několika zeměmi:
cURL
curl "https://numlook.ru/api/v1/phone/validate?phone=3201234567&country=IT,US,DE&api_key=your_key"
POST požadavek s polem zemí:
cURL
curl -X POST "https://numlook.ru/api/v1/phone/validate" \
-H "Content-Type: application/json" \
-d '{
"phone": "3201234567",
"country": ["IT", "US", "DE"],
"api_key": "your_key"
}'
JavaScript (fetch)
Validace čísla:
JavaScript
// Number validation
fetch('https://numlook.ru/api/v1/phone/validate?phone=+393201234567&api_key=your_key')
.then(response => response.json())
.then(data => console.log(data));
S několika zeměmi:
JavaScript
// With multiple countries
fetch('https://numlook.ru/api/v1/phone/validate?phone=3201234567&country=IT,US,DE&api_key=your_key')
.then(response => response.json())
.then(data => console.log(data));
POST požadavek s polem zemí:
JavaScript
// POST request with array of countries
fetch('https://numlook.ru/api/v1/phone/validate', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
phone: '3201234567',
country: ['IT', 'US', 'DE'],
api_key: 'your_key'
})
})
.then(response => response.json())
.then(data => console.log(data));
PHP
Validace jednoho čísla:
PHP
// Single number validation
$apiKey = 'your_key';
$phone = '+393201234567';
$response = file_get_contents(
"https://numlook.ru/api/v1/phone/validate?phone=" . urlencode($phone) . "&api_key=" . $apiKey
);
$data = json_decode($response, true);
var_dump($data);
S několika zeměmi:
PHP
// With multiple countries
$apiKey = 'your_key';
$phone = '3201234567';
$countries = 'IT,US,DE';
$response = file_get_contents(
"https://numlook.ru/api/v1/phone/validate?phone=" . urlencode($phone) . "&country=" . urlencode($countries) . "&api_key=" . $apiKey
);
$data = json_decode($response, true);
var_dump($data);
POST požadavek s polem zemí:
PHP
// POST request with array of countries
$apiKey = 'your_key';
$postData = json_encode([
'phone' => '3201234567',
'country' => ['IT', 'US', 'DE'],
'api_key' => $apiKey
]);
$context = stream_context_create([
'http' => [
'method' => 'POST',
'header' => 'Content-Type: application/json',
'content' => $postData
]
]);
$response = file_get_contents('https://numlook.ru/api/v1/phone/validate', false, $context);
$data = json_decode($response, true);
var_dump($data);