Sur cette page

Commencer

Démarrage rapide de l’API

Offre de l’outil: Pro

Couverture: Sur /v1/data/* + /v2/*, une clé valide remplace la preuve ByteGuard du navigateur. Expiration, révocation, abonnement, crédits et limites restent contrôlés. Elle n’autorise pas les autres routes. openapi.json et products sont publics.

Clé API et crédits
Sur cette page

Obtenez votre clé API

Attention

Vous avez besoin de crédits : les 20 par mois inclus avec un compte Pro actif, ou des crédits achetés sur la page de votre compte. Un compte qui n’a ni les uns ni les autres reçoit 403 pro_required.

Important

Cette clé n’est affichée qu’une fois. Conservez-la en sécurité sur votre serveur.

L’API nécessite un compte Pro actif. Dans votre compte, créez une clé API et copiez-la : elle ne s’affiche qu’une seule fois. Enregistrez-la comme secret NOCALL_API_KEY sur votre serveur, jamais dans du code exécuté par le navigateur.

  1. Créez une API key dans votre compte et copiez la valeur affichée une seule fois. Configurez NOCALL_API_KEY comme secret sur votre serveur. Utilisez HTTPS ; ne mettez jamais la clé dans le code du navigateur, les dépôts, captures ou journaux.

  2. Envoyez la clé complète dans Authorization: Bearer, avec un espace après Bearer. N’utilisez pas X-API-Key et ne placez pas la clé dans l’URL.

Votre première requête

Envoyez POST /v2/tools avec l’en-tête Authorization: Bearer et un corps JSON contenant tool et phone, par exemple pour who-calls. Utilisez une nouvelle Idempotency-Key pour chaque opération afin de pouvoir la réessayer sans second débit.

Les 44 tools sont tous disponibles via l’API : appelez POST /v2/<tool-id>, ou POST /v2/tools avec le champ tool dans le corps. Chaque tool a son propre corps JSON, documenté dans son guide. data.result contient le résultat du tool. Utilisez les identifiants du tableau.

bash
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"}'

La réponse

Remarque

Exemple inventé, pas une recherche réelle. N’appelez pas et n’ouvrez pas ses liens.

data.result contient le résultat et meta inclut requestId, unitsCharged et l’usage de la période. La référence API détaille les champs de toutes les tools.

data contient le résultat ; meta fournit requestId, unitsCharged et l’utilisation si applicable. L’extrait fictif montre le solde après une requête. Un résultat valide sans données coûte aussi 1 crédit ; les erreurs de validation ou de fournisseur et la lecture du solde ne sont pas facturées. L’absence de données ne prouve pas qu’un numéro est sûr. Les schémas complets figurent dans OpenAPI.

Crédits et erreurs

Chaque résultat valide consomme 1 crédit, même sans données ; les erreurs de validation sont gratuites. 401 signifie que la clé est absente ou invalide, 403 qu’aucun Pro n’est actif et 429 que les crédits sont épuisés ou que la limite de requêtes est atteinte.

Guides associés