crisphive

Para IA

Todo lo que un asistente de programación con IA necesita para construir una integración con CrispHive: un prompt listo para pegar, recursos legibles por máquina y los datos clave de la API en un solo lugar.

Instale con IA

Pegue este prompt en su asistente de programación con IA para poner en marcha una integración:

Read the CrispHive backend integration skill at
https://api.crisphive.com/developers/SKILL.md and the OpenAPI spec at
https://api.crisphive.com/developers/openapi.json.

Then implement a client for my backend that:
1. Authenticates with an API key as a Bearer token (chsk_test_… for sandbox)
2. Creates a customer and a job request
3. Keeps job requests in sync by polling GET /v1/job-requests/changes
   with the next_since cursor
Cada respuesta usa una misma estructura de sobre — { error_code, message, errors, data } — de modo que los clientes generados pueden compartir un único analizador de respuestas.

Recursos legibles por máquina

Ambos archivos los sirve la propia API, por lo que siempre coinciden con la versión desplegada: apunte su asistente directamente a estas URL en lugar de copiar páginas de documentación en su contexto.

RecursoQué contiene
SKILL.mdUna guía de integración condensada escrita para agentes: autenticación, sobre de respuesta, flujos principales de reservas y errores comunes.
openapi.jsonLa especificación OpenAPI completa: cada endpoint, esquema de solicitud/respuesta y código de error. Úsela para generar clientes tipados.

Datos clave para su asistente

  • La URL base es https://api.crisphive.com/v1: sandbox y live comparten las mismas rutas; el entorno se selecciona con el prefijo de la clave (chsk_test_… vs chsk_live_…).
  • Autentique cada solicitud con Authorization: Bearer <api key>. Las claves no caducan y otorgan acceso completo: manténgalas en el servidor.
  • Un error_code de 0 significa éxito; cualquier otro valor es un error, y los fallos de validación detallan cada campo en errors.
  • Replique datos consultando GET /v1/job-requests/changes con el cursor next_since devuelto, en lugar de volver a listar recursos.
  • Los webhooks siguen en versión preliminar: por ahora, base la sincronización fiable en el feed de cambios.

Consejos para mejores resultados

  • Haga que el asistente lea primero SKILL.md: es lo bastante pequeño para caber en el contexto y responde la mayoría de las preguntas de integración sin la especificación completa.
  • Genere los tipos de solicitud/respuesta a partir de openapi.json en lugar de dejar que el modelo adivine los nombres de los campos.
  • Desarrolle con una clave de sandbox (chsk_test_…) y pase a live solo cuando los flujos funcionen de extremo a extremo.
  • Al depurar, compruebe error_code, no solo el estado HTTP.