CERTIPROV

Appearance

Integraciones y API ​

La API de CertiProv permite conectar sistemas externos (ERP, CRM, sistemas contables o plataformas de analítica empresarial) para consultar y sincronizar información de los procesos gestionados en la plataforma de manera automatizada y segura.

Información General ​

  • Host Base: https://api.certiprov.com/api/
  • Protocolo: HTTPS (todas las peticiones deben viajar sobre TLS/HTTPS)
  • Formato de datos: JSON (application/json; charset=utf-8)
  • Autenticación: Cabecera HTTP personalizada x-api-key

Autenticación ​

Todas las solicitudes a los endpoints de la API requieren una API Key válida que debe enviarse en la cabecera HTTP x-api-key.

NOTA

La API Key es generada y suministrada directamente por el Superadministrador de la plataforma CertiProv al equipo responsable de la integración técnica.

Tipos de API Key ​

  • API Key de Empresa (cp_live_...): Concede acceso exclusivamente a los datos y procesos pertenecientes a su propia organización o empresa (Tenant Scoped).
  • API Key de Sistema (cp_sys_...): Concede acceso global entre empresas (Cross-Tenant), recomendada para plataformas corporativas o sincronizadores centrales.

Formato de Cabecera en las Peticiones ​

En cada petición HTTP, incluya las siguientes cabeceras:

http
x-api-key: cp_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

Códigos de Estado y Manejo de Errores ​

La API utiliza códigos de respuesta estándar del protocolo HTTP:

CódigoEstadoCausa y Solución
200 OKÉxitoLa solicitud fue procesada correctamente y retorna la estructura de datos solicitada.
400 Bad RequestPetición InválidaParámetros de consulta incorrectos, formatos de fecha inválidos o tipos de datos no admitidos.
401 UnauthorizedNo AutorizadoLa API Key no fue enviada en la cabecera x-api-key, es inválida o se encuentra inactiva.
404 Not FoundNo EncontradoEl recurso solicitado no existe o no pertenece a la empresa vinculada a la API Key.
500 Internal ErrorError de ServidorOcurrió un inconveniente interno al procesar la solicitud en el servidor.

Buenas Prácticas de Integración ​

  1. Almacenamiento Seguro: Guarde siempre las API Keys en variables de entorno o almacenes seguros de secretos (como Azure Key Vault o AWS Secrets Manager). Nunca exponga las llaves en código fuente de aplicaciones clientes ni en repositorios públicos.
  2. Paginación Controlada: En endpoints que retornan colecciones, utilice siempre los parámetros de paginación (page y pageSize) para evitar sobrecarga en grandes volúmenes de datos.
  3. Manejo de Errores y Reintentos: Implemente lógica de captura de errores y reintentos con retroceso exponencial (exponential backoff) ante eventuales respuestas transitorias.

Módulos Disponibles ​

Consulte la documentación específica de cada módulo de integración:

  • Adquisiciones Adjudicadas: Endpoints para listar y obtener el detalle íntegro de los procesos de contratación adjudicados a proveedores ganadores.