Documentación API
Documentación completa de la API pública de Mapfolio - Accede a datos de empresas suizas mediante programación
Resumen
La API de Mapfolio proporciona acceso programático a datos de empresas suizas a través de una interfaz RESTful. Todos los endpoints están documentados usando la especificación OpenAPI 3.0, garantizando consistencia y facilidad de integración.
Comenzar
Autenticación
La API de Mapfolio utiliza autenticación por clave API. Puedes obtener tu clave API desde tu configuración de cuenta.
Encabezado de clave API:
X-API-Key: mapf_tu_clave_api_aqui
Token Bearer (Alternativa):
Authorization: Bearer mapf_tu_clave_api_aqui
URL base
Todas las solicitudes API deben realizarse a:
https://mapfolio.app
Límite de velocidad
Las solicitudes API están limitadas en velocidad para garantizar un uso justo:
- Solicitudes autenticadas: 1000 solicitudes por hora por clave API
- Solicitudes no autenticadas: 10 solicitudes por hora por dirección IP
La información del límite de velocidad se incluye en los encabezados de respuesta:
X-RateLimit-Limit: Número máximo de solicitudes permitidasX-RateLimit-Remaining: Solicitudes restantes en la ventana actualX-RateLimit-Reset: Marca de tiempo Unix cuando se restablece el límite
Endpoints disponibles
Búsqueda de empresas
Busca empresas con opciones de filtrado avanzadas:
- Búsqueda de texto en nombres de empresas
- Filtrar por cantón (cantones suizos)
- Filtrar por estado de empresa
- Soporte de paginación
Detalles de empresa
Recupera información detallada sobre empresas específicas:
- Datos del perfil de empresa
- Información de ubicación
- Estado legal
- Detalles de registro
Estadísticas
Accede a estadísticas agregadas sobre empresas suizas:
- Recuentos totales de empresas
- Estadísticas a nivel de cantón
- Distribuciones basadas en letras
- Recuentos de combinaciones de dos letras
Autocompletado
Obtén sugerencias de autocompletado para:
- Nombres de empresas
- Ciudades
- Códigos postales
Empresas aleatorias
Recupera muestras aleatorias de empresas para pruebas y exploración.
Formato de respuesta
Todas las respuestas API exitosas siguen una estructura consistente:
{
"data": [...],
"pagination": {
"page": 1,
"limit": 20,
"total": 100,
"totalPages": 5
}
}
Las respuestas de error incluyen información detallada:
{
"error": "Mensaje de error",
"details": "Detalles adicionales del error"
}
Códigos de error
- 400 Bad Request: Parámetros de solicitud inválidos
- 401 Unauthorized: Clave API faltante o inválida
- 403 Forbidden: Permisos insuficientes
- 404 Not Found: Recurso no encontrado
- 429 Too Many Requests: Límite de velocidad excedido
- 500 Internal Server Error: Error del servidor
Especificación OpenAPI
La especificación OpenAPI 3.0 completa está disponible en:
- Documentación interactiva: /api-docs.html
- OpenAPI JSON: /api/docs/openapi.json
Puedes usar la especificación OpenAPI con cualquier herramienta compatible:
- Swagger UI
- Postman
- Insomnia
- Generadores de código para bibliotecas cliente
Ejemplos de código
cURL
curl -H "X-API-Key: mapf_tu_clave_api_aqui" \
https://mapfolio.app/api/search?q=tecnologia
JavaScript (Fetch)
const response = await fetch('https://mapfolio.app/api/search?q=tecnologia', {
headers: {
'X-API-Key': 'mapf_tu_clave_api_aqui'
}
})
const data = await response.json()
Python (Requests)
import requests
headers = {'X-API-Key': 'mapf_tu_clave_api_aqui'}
response = requests.get(
'https://mapfolio.app/api/search',
params={'q': 'tecnologia'},
headers=headers
)
data = response.json()
Soporte
Para soporte API y preguntas:
- Documentación: Visita la documentación API interactiva
- Email: support@mapfolio.app
- Problemas: Reporta problemas a través del panel de tu cuenta
Términos de uso
Al usar la API de Mapfolio, aceptas nuestros Términos de servicio y nuestra Política de privacidad. Por favor revisa los límites de velocidad y las pautas de uso para asegurar el cumplimiento.