API-dokumentaatio

API-avain
Kirjaudu sisään Rekisteröityminen
Käytettävissä olevat menetelmät
Menetelmä URL Kuvaus Asetukset
GET/POST /api/v1/phone/validate Numeron validointi phone, country, api_key
Parametrit:
Parametri Kuvaus Esimerkki Pakollinen
api_key API-avain your_key Kyllä
phone Puhelinnumero +393201234567 Kyllä
country Maatunnus IT, ["IT","US","DE"] Ei
Työskentely useiden maiden kanssa

Parametri country tukee useita muotoja:

  • Yksi maa: IT
  • Useita maita pilkulla erotettuna: IT,US,DE
  • Useita maita puolipisteellä erotettuna: IT;US;DE
  • Useita maita välilyönnillä erotettuna: IT US DE
  • Maat array (POST): ["IT", "US", "DE"]

API yrittää jäsentää numeron jokaisen maan kanssa vuorotellen, kunnes löytyy kelvollinen tulos. Tämä on erityisen hyödyllistä numeroille kansallisessa muodossa.

Vastauskoodit
Koodi Kuvaus Esimerkki
200 Onnistunut pyyntö 
{
  "success": true,
  "data": {
    "is_valid": true,
    "type_id": 1,
    "type_name": "Mobile",
    "is_mobile": true,
    "is_fixed_line": false,
    "phone_code": "+39",
    "country_code": "IT",
    "location": null,
    "international": "+39 320 123 4567",
    "national": "320 123 4567",
    "e164": "+393201234567",
    "rfc3966": "tel:+39-320-123-4567"
  },
  "error": null,
  "request_id": "a430273e63f07ef5805f04e5f8a94d16f0351fd7"
}
400 Virheellinen pyyntö (virhe parametreissa) 
{
  "success": false,
  "data": null,
  "error": "Invalid phone number",
  "request_id": "b1e2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}
401 Ei valtuutettu (virheellinen tai puuttuva API-avain) 
{
  "success": false,
  "data": null,
  "error": "Invalid API key",
  "request_id": "c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7"
}
403 Pääsy estetty (ei oikeuksia tai estetty) 
{
  "success": false,
  "data": null,
  "error": "Access denied",
  "request_id": "d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8"
}
404 Menetelmää tai resurssia ei löytynyt 
{
  "success": false,
  "data": null,
  "error": "Method or resource not found",
  "request_id": "e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9"
}
429 Pyyntöraja ylitetty 
{
  "success": false,
  "data": null,
  "error": "Request limit exceeded",
  "request_id": "f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0"
}
500 Sisäinen palvelinvirhe 
{
  "success": false,
  "data": null,
  "error": "Internal server error",
  "request_id": "a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1"
}
Testi API-avain: test
Jos käytät tätä avainta pyynnöissä, API palauttaa aina esittelyvastauksen (mock).
Saldoa ei vähennetä, todellisia tarkistuksia ei suoriteta.
Esimerkki: 
curl "https://numlook.ru/api/v1/phone/validate?phone=+393201234567&api_key=test"
Käyttöesimerkit
cURL-komennot
Numeron validointi:
cURL 
curl "https://numlook.ru/api/v1/phone/validate?phone=+393201234567&api_key=your_key"
Useilla mailla:
cURL 
curl "https://numlook.ru/api/v1/phone/validate?phone=3201234567&country=IT,US,DE&api_key=your_key"
POST-pyyntö maiden taulukolla:
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)
Numeron validointi:
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));
Useilla mailla:
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-pyyntö maiden taulukolla:
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
Yhden numeron validointi:
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);
Useilla mailla:
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-pyyntö maiden taulukolla:
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);