API:mme on nopea ja helppo integroida — saat sen käyttöön alle 15 minuutissa. Lisäksi saat 50 ilmaista pyyntöä päivässä aloittaaksesi.
Kaikki API-pyynnöt tulee lähettää POST-metodilla. Kaikkien pyyntöjen perusosoite on:
https://numvalid.com/api/v1/[api_key]
Korvaa [api_key] omalla API-avaimellasi. Kaikki pyynnön parametrit tulee lähettää JSON-muodossa pyynnön rungossa. Voit saada API-avaimesi hallintapaneelistasi rekisteröitymisen jälkeen.
Metodi: test
Tätä metodia käytetään API-yhteyden testaamiseen. Se varmistaa, että API-avaimesi on validi ja palvelu on tavoitettavissa. Jos kaikki on oikein määritetty, API palauttaa onnistuneen vastauksen.
Pyyntöesimerkki
{
"method": "test"
}Onnistunut vastaus
{
"error": 0,
"message": "Yippee-ki-yay"
}
Vastauksen kentät
error — virhekoodi (0 tarkoittaa, että pyyntö onnistui)
message — API:n vastausviesti
Metodi: info
Info-metodi palauttaa tietoja tilistäsi ja nykyisestä tilauksesta, mukaan lukien käytettyjen API-pyyntöjen määrän.
Pyyntöesimerkki
{
"method": "info"
}Onnistunut vastaus
{
"error": 0,
"name": "John",
"surname": "Smith",
"email": "[email protected]",
"subscription": "Growth",
"count_request": 2349
}
Vastauksen kentät
error — virhekoodi (0 tarkoittaa, että pyyntö onnistui)
name — tilin omistajan etunimi
surname — tilin omistajan sukunimi
email — tilin sähköpostiosoite
subscription — nykyinen tilauspaketti
count_request — nykyisen tilausjakson aikana käytettyjen API-pyyntöjen määrä
Metodi: verify
Verify-metodi tarkistaa puhelinnumeron ja palauttaa yksityiskohtaiset validointitiedot.
Puhelinnumerot voidaan antaa missä tahansa muodossa. API käsittelee automaattisesti merkit kuten
(, ), -,
+ ja välilyönnit.
Pyyntöesimerkki
{
"phone": "491609502065",
"method": "verify"
}Onnistunut vastaus
{
"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
}
}
Vastauksen kentät
error — virhekoodi (0 tarkoittaa, että pyyntö onnistui)
request_phone — pyynnössä lähetetty puhelinnumero
valid_phone — validointitulos (true jos numero on validi)
type — puhelinnumeron tyyppi (esim. matkapuhelin, lankapuhelin jne.)
Muoto-objekti
local — puhelinnumero paikallisessa muodossa
international — puhelinnumero kansainvälisessä muodossa
Maa-objekti
code — ISO-maakoodi
name — maan nimi
prefix — kansainvälinen suuntanumero
Pyyntö-objekti
Tietoja nykyisestä tilauskäytöstäsi.
subscription — aktiivinen tilauspaketti
count — jo käytettyjen pyyntöjen määrä
start — tilausjakson alkamispäivä
finish — tilausjakson päättymispäivä
limit — tilausjakson sallittu enimmäispyyntömäärä
Onko sinulla kysymyksiä API-dokumentaatiosta? Ota yhteyttä: