API REST
Tous les endpoints de l’API REST de findbytown, avec l’URL de base, le format des réponses et la pagination.
URL de base : https://findbytown.com/api/v1. Les requêtes et les réponses sont en JSON. La description complète est disponible sous forme de document OpenAPI 3.1.
| Endpoint | Description |
|---|---|
| GET /businesses | Rechercher des entreprises |
| GET /businesses/count | Compter les entreprises |
| GET /businesses/{id} | Obtenir une entreprise |
| GET /businesses/{id}/reveal | Vérifier le coût d’une révélation |
| POST /businesses/{id}/reveal | Révéler une entreprise |
| GET /quota | Obtenir votre quota et vos limites |
| GET /categories | Lister les catégories et les métiers |
| GET /countries | Lister les pays |
| GET /zones | Lister les zones |
Réponses
Une réponse réussie place son contenu dans data. Une réponse en échec contient un code error, un message et un requestId, comme décrit dans Erreurs. Les identifiants sont toujours des entiers.
Pagination
GET /businesses accepte page et perPage, et répond avec page, perPage, total, maxPage et hasMore. Une page contient au maximum 50 lignes ; si vous en demandez plus, perPage dans la réponse indique la valeur appliquée. Au-delà de maxPage, vous obtenez une page vide avec capped: true et total: null. Pour en voir plus, affinez la recherche avec un filtre, par exemple par zone.
Navigateurs
L’API REST n’envoie aucun en-tête CORS, donc une page web d’un autre site ne peut pas l’appeler. Appelez-la depuis votre serveur.