Ejemplos de la API de CapData

Esta sección proporciona ejemplos prácticos de cómo usar los endpoints de la API de CapData en escenarios del mundo real.

Ejemplos de Autenticación

Usando API Key

GET /api/contacts HTTP/1.1
Host: capdata.es
X-API-Key: tu_api_key_aqui
Content-Type: application/json

Usando Token de Empleado

GET /api/contacts HTTP/1.1
Host: capdata.es
X-Employee-Token: tu_token_de_empleado_aqui
Content-Type: application/json

Ejemplos de la API Principal

Extraer Datos de Vuelo

POST /api/extract HTTP/1.1
Host: capdata.es
X-API-Key: tu_api_key_aqui
Content-Type: application/json

{
  "html": "<html>Contenido HTML de la reserva de vuelo</html>",
  "context": {
    "is_vueling": false
  },
  "include_avsis": false
}

Enviar a Clientify

POST /api/sendToClientify HTTP/1.1
Host: capdata.es
X-API-Key: tu_api_key_aqui
Content-Type: application/json

{
  "clientify_token": "tu_token_de_clientify",
  "flight_data": {
    "codigo_reserva": "ABC123",
    "nombre_pasajero": "John Doe",
    "aerolinea": "Iberia",
    "fecha_vuelo": "2025-01-15"
  }
}

Listar Contactos con Paginación

GET /api/contacts?page=1&per_page=50&search=john&entity_type=person&role=passenger HTTP/1.1
Host: capdata.es
X-API-Key: tu_api_key_aqui

Ejemplos de la API de Chat

Crear Carpeta de Chat

POST /api/chat/folders HTTP/1.1
Host: capdata.es
X-API-Key: tu_api_key_aqui
Content-Type: application/json

{
  "name": "Soporte al Cliente"
}

Enviar Mensaje

POST /api/chat/conversations/1/messages HTTP/1.1
Host: capdata.es
X-API-Key: tu_api_key_aqui
Content-Type: application/json

{
  "content": "Hola, necesito ayuda con mi reserva",
  "conversation_id": 1
}

Ejemplos de la API de Gestión

Crear Agencia

POST /api/management/agencies HTTP/1.1
Host: capdata.es
X-Owner-API-Key: tu_api_key_de_propietario_aqui
Content-Type: application/json

{
  "name": "Agencia de Viajes Madrid",
  "email": "contacto@viajesmadrid.com",
  "password": "una_contraseña_segura",
  "consumes_owner_tokens": true,
  "contact_person": "María García",
  "phone_number": "+34123456789"
}

Crear Agente

POST /api/management/agents HTTP/1.1
Host: capdata.es
X-Owner-API-Key: tu_api_key_de_propietario_aqui
Content-Type: application/json

{
  "name": "Carlos López",
  "username": "carlos_lopez",
  "password": "una_contraseña_segura"
}

Ejemplos de la API de Integraciones

Listar Integraciones

GET /api/v1/integrations HTTP/1.1
Host: capdata.es
X-API-Key: tu_api_key_aqui

Actualizar Integración

PUT /api/v1/integrations/visagov HTTP/1.1
Host: capdata.es
X-API-Key: tu_api_key_aqui
Content-Type: application/json

{
  "enabled": true,
  "settings": {
    "api_key": "tu_api_key_de_visagov",
    "webhook_url": "https://tu-dominio.com/webhook"
  }
}

Ejemplos de Health Check

Ping

GET /api/health/ping HTTP/1.1
Host: capdata.es

Salud de la Base de Datos

GET /api/health/database HTTP/1.1
Host: capdata.es

Ejemplos de Respuesta

Respuesta Exitosa

{
  "success": true,
  "data": {
    "id": 123,
    "message": "Operación completada exitosamente"
  },
  "timestamp": "2025-01-15T10:30:00Z"
}

Respuesta de Error

{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "La API key proporcionada es inválida",
    "details": "Por favor, comprueba tu API key e inténtalo de nuevo"
  },
  "timestamp": "2025-01-15T10:30:00Z"
}

💡 Consejo: Usa la Colección de Postman para probar estos ejemplos con peticiones y entornos preconfigurados.

⚠️ Nota de Seguridad: Usa siempre HTTPS en producción y nunca expongas tus API keys en el código del lado del cliente.