Révéler une entreprise

Consomme une révélation de votre quota mensuel et renvoie la fiche avec le domaine, le site web et les contacts. Révéler de nouveau la même entreprise pendant la même période est gratuit, et charged l’indique.

POSThttps://findbytown.com/api/v1/businesses/{id}/revealConsomme du quota

Paramètres de chemin

Nom	Type	Description
id(requis)	integer	Identifiant de l’entreprise, un entier.

Corps JSON (facultatif)

Nom	Type	Description
locale	en \| fr \| es	Langue des libellés et des noms de catégories : en, fr ou es. Par défaut, la langue de votre compte.

Exemples

curl -X POST "https://findbytown.com/api/v1/businesses/1001/reveal" \
  -H "Authorization: Bearer fbt_EXAMPLE_not_a_real_key_0000"

const res = await fetch("https://findbytown.com/api/v1/businesses/1001/reveal", {
  method: "POST",
  headers: { Authorization: "Bearer fbt_EXAMPLE_not_a_real_key_0000" },
});
const body = await res.json();
if (!res.ok) throw new Error(body.error);
console.log(body);

import requests

res = requests.post(
    "https://findbytown.com/api/v1/businesses/1001/reveal",
    headers={"Authorization": "Bearer fbt_EXAMPLE_not_a_real_key_0000"},
)
body = res.json()
if not res.ok:
    raise RuntimeError(body["error"])
print(body)

Réponse

Exemple avec des valeurs fictives :

{
  "data": {
    "id": 1001,
    "domain": "plumbing.example",
    "name": "Example Plumbing",
    "website": "https://plumbing.example/",
    "zone": "fr_idf",
    "zoneLabels": {
      "en": "Example Region",
      "fr": "Région Exemple",
      "es": "Región Ejemplo"
    },
    "country": "FR",
    "precision": "exact",
    "address": "1 Example Street",
    "city": "Exampleville",
    "quality": 80,
    "provider": "google",
    "providerDetail": "Google Workspace",
    "hasPhone": true,
    "contactsCount": 1,
    "otherEmailsCount": 0,
    "description": "Plumbing and heating repairs.",
    "logoUrl": null,
    "social": {},
    "openingHours": null,
    "activity": "Plumber",
    "categories": [
      "Heating contractor"
    ],
    "websiteTitle": null,
    "postalCode": "00000",
    "adminArea": "Example Region",
    "fullAddress": "1 Example Street, 00000 Exampleville",
    "mapsUrl": null,
    "rating": 4.6,
    "reviews": 25,
    "facts": null,
    "extraPhonesCount": 0,
    "primaryEmailMasked": "c•••@•••",
    "phoneMasked": "+33 1 •• •• •• 00",
    "revealed": true,
    "contact": {
      "email": "contact@plumbing.example",
      "otherEmails": [],
      "phone": "+33100000000",
      "extraPhones": [],
      "contacts": [
        {
          "fullName": "Alex Example",
          "title": "Manager",
          "email": "alex@plumbing.example"
        }
      ]
    }
  },
  "charged": true,
  "quota": {
    "used": 13,
    "allowance": 10000,
    "remaining": 9987,
    "resetAt": "2030-01-01T00:00:00.000Z"
  }
}

Erreurs

Code	Statut HTTP	Signification
validation_error	400	Un paramètre est manquant ou mal formé. details indique lequel.
bad_id	400	L’identifiant de l’entreprise n’est pas un entier positif.
missing_api_key	401	En-tête Authorization absent ou vide.
invalid_api_key	401	La clé n’existe pas ou a été révoquée.
quota_exhausted	402	Plus aucune révélation disponible pour cette période. details contient la date de réinitialisation. La lecture reste possible.
plan_without_api	403	L’offre actuelle du compte n’inclut pas l’API. S’applique dès la fin d’une offre.
suspended	403	Le compte est suspendu. Ses clés refonctionnent si la suspension est levée.
not_found	404	Cette entreprise n’existe pas, ou elle a été retirée à la demande de son propriétaire.
email_invalid	409	L’email de cette entreprise est marqué comme invalide, elle ne peut donc pas être révélée. Rien n’a été consommé.
rate_limited	429	Trop de requêtes cette minute. Attendez le nombre de secondes indiqué dans Retry-After.
blocked	429	L’accès aux données d’entreprises est temporairement suspendu en raison d’un usage automatisé, comme le parcours des identifiants. Retry-After indique le temps restant. Écrivez au support s’il s’agit d’une erreur.
internal_error	500	Une erreur s’est produite de notre côté. Indiquez requestId en écrivant au support.
reveals_unavailable	503	Les révélations sont brièvement indisponibles et rien n’a été consommé. Réessayez dans quelques instants.

Retour à findbytown