API REST
La API REST de PeekHire permite que tu software trabaje con tus datos de reclutamiento. Es una API estándar HTTPS + JSON — cualquier lenguaje que haga peticiones web puede usarla.
Explora cada endpoint, parámetro y esquema en la referencia OpenAPI interactiva:
Abrir la referencia de la APIURL base y versionado
La API está versionada. Todos los endpoints viven bajo el prefijo /api/v1, para
que los cambios futuros no rompan tu integración.
Autenticación
Autentica cada petición con una clave API como bearer token:
curl https://tu-host-api/api/v1/campaigns \
-H "Authorization: Bearer TU_CLAVE_API"
Nunca incluyas una clave API en código de cliente o un repositorio público.
A qué accedes
La API v1 cubre los objetos de reclutamiento principales:
- Campaigns — listar y obtener los puestos.
- Applications — listar y obtener candidaturas.
- Users — listar y obtener miembros del espacio.
Las respuestas son JSON e incluyen los mismos campos que la app, como el título y el estado de una campaña o la fase y el idioma de una candidatura.
Paginación y filtros
Los endpoints de lista devuelven resultados por páginas. Usa los parámetros de paginación y los filtros para cargar solo lo necesario.
Errores
La API usa códigos HTTP estándar — 2xx para éxito, 4xx para problemas con tu
petición (como una clave que falta), 5xx para errores del servidor. Las
respuestas de error incluyen un mensaje descriptivo.
Relacionado
- Claves API
- Webhooks para push en vez de polling