API REST
Todos los endpoints de la API REST de findbytown, con la URL base, el formato de respuesta y la paginación.
URL base: https://findbytown.com/api/v1. Las solicitudes y las respuestas son JSON. La descripción completa está disponible como documento OpenAPI 3.1.
| Endpoint | Descripción |
|---|---|
| GET /businesses | Buscar empresas |
| GET /businesses/count | Contar empresas |
| GET /businesses/{id} | Obtener una empresa |
| GET /businesses/{id}/reveal | Consultar el coste de una revelación |
| POST /businesses/{id}/reveal | Revelar una empresa |
| GET /quota | Consultar tu cuota y tus límites |
| GET /categories | Listar categorías y oficios |
| GET /countries | Listar países |
| GET /zones | Listar zonas |
Respuestas
Una respuesta correcta pone su contenido en data. Una fallida tiene un código error, un message y un requestId, como se describe en Errores. Los ids son siempre enteros.
Paginación
GET /businesses acepta page y perPage, y responde con page, perPage, total, maxPage y hasMore. Una página contiene como máximo 50 filas; si pides más, perPage en la respuesta indica lo que se aplicó. Más allá de maxPage recibes una página vacía con capped: true y total: null. Para ver más, acota la búsqueda con un filtro, por ejemplo por zona.
Navegadores
La API REST no envía cabeceras CORS, así que una página web de otro sitio no puede llamarla. Llámala desde tu servidor.