Rychlý start s API

Získejte klíč API

API vyžaduje aktivní účet Pro. Ve svém účtu vytvořte klíč API a zkopírujte ho: zobrazí se jen jednou. Uložte ho jako tajný údaj NOCALL_API_KEY na svém serveru, nikdy do kódu v prohlížeči.

1. 1

   V účtu vytvoř API klíč a zkopíruj jednou zobrazenou hodnotu. Nastav NOCALL_API_KEY jako tajný údaj na serveru. Používej HTTPS; nikdy nedávej klíč do kódu prohlížeče, repozitářů, snímků ani logů.

2. 2

   Pošli celý klíč v Authorization: Bearer s jednou mezerou za Bearer. Nepoužívej X-API-Key ani klíč v URL.

• Vytvořit klíč API ↗

Váš první požadavek

Odešlete POST /v2/tools s hlavičkou Authorization: Bearer a tělem JSON s poli tool a phone, například pro who-calls. Pro každou operaci použijte nový Idempotency-Key, abyste ji mohli zopakovat bez druhého účtování.

Všech 44 toolů je dostupných přes API: zavolejte POST /v2/<tool-id>, nebo POST /v2/tools s polem tool v těle. Každý tool má vlastní tělo JSON, popsané v jeho návodu. data.result obsahuje výsledek toolu. Používejte identifikátory z tabulky.

REQUEST_ID="$(uuidgen)" && [ -n "$REQUEST_ID" ] &&
curl --request POST 'https://api.nocall.io/v2/tools' \
  --header "Authorization: Bearer $NOCALL_API_KEY" \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $REQUEST_ID" \
  --data '{"tool":"who-calls","phone":"+12025550123","country":"US"}'

import json
import os
import urllib.request
import uuid

api_key = os.environ.get('NOCALL_API_KEY')
if not api_key:
    raise SystemExit('Set NOCALL_API_KEY')

request = urllib.request.Request(
    'https://api.nocall.io/v2/tools',
    method='POST',
    data=json.dumps({'tool': 'who-calls', 'phone': '+12025550123', 'country': 'US'}).encode(),
    headers={
        'Authorization': 'Bearer ' + api_key,
        'Content-Type': 'application/json',
        'Idempotency-Key': str(uuid.uuid4()),
    },
)
with urllib.request.urlopen(request, timeout=30) as response:
    result = json.load(response)
print(result['data']['result'], result['meta']['unitsCharged'])

import { randomUUID } from 'node:crypto';

const requestId = randomUUID();
const apiKey = process.env.NOCALL_API_KEY;
if (!apiKey) throw new Error('Set NOCALL_API_KEY');

const response = await fetch('https://api.nocall.io/v2/tools', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer ' + apiKey,
    'Content-Type': 'application/json',
    'Idempotency-Key': requestId,
  },
  body: JSON.stringify({ tool: 'who-calls', phone: '+12025550123', country: 'US' }),
});
const result = await response.json();
if (!response.ok) throw new Error(result.error?.code ?? 'request_failed');
console.log(result.data.result, result.meta.unitsCharged);

Odpověď

data.result obsahuje výsledek a meta obsahuje requestId, unitsCharged a využití za období. Dokumentace API popisuje pole všech tools.

data obsahuje výsledek; meta zahrnuje requestId, unitsCharged a případné využití. Fiktivní ukázka zobrazuje zůstatek po dotazu. Platný výsledek bez dat také stojí 1 kredit; chyby validace, poskytovatele a čtení zůstatku jsou zdarma. Chybějící data nedokazují bezpečnost čísla. Úplná schémata jsou v OpenAPI.

Kredity a chyby

Každý platný výsledek spotřebuje 1 kredit, i když neobsahuje data; chyby validace jsou zdarma. 401 znamená chybějící nebo neplatný klíč, 403 chybějící aktivní Pro a 429 vyčerpané kredity nebo dosažený limit požadavků.

Související návody

• Dokumentace APIKaždé volání API stojí 1 kredit. Nejprve se čerpají měsíční.
• Kdo mi volá?Zjistěte, kdo volal z neznámého čísla. Zkontrolujte hlášení komunity, ověřte předvolby a chraňte se před telefonními podvody.
• Riziko telefonuZadejte číslo a zobrazte schválené údaje omezené ochranou soukromí.

Související návody

• Dokumentace API
• Kdo mi volá?
• Riziko telefonu