Descripción

Integración completa con APIs REST para sincronización bidireccional. Incluye migración inicial por lotes y sincronización continua automática.

Requisitos Técnicos

Autenticación y seguridad

Todas las peticiones requieren un token de autenticación enviado en el header:

x-api-key: {api_key}

Si una solicitud proviene de una IP no autorizada, la API responderá con un error 403 – Forbidden, incluso si el API Key es válido.

Endpoints Disponibles

Estudiantes

Crear o actualizar información de un estudiante (Upsert)

{
    "status": 201,
    "success": true,
    "message": "Estudiante creado exitosamente",
    "result": "created",
    "data": {
        "university_id": "UTest"
    }
}

Referencia de campos

Empleadores

Crear o actualizar información de un empleador (Upsert)

{
    "status": 201,
    "success": true,
    "message": "Companie creado exitosamente",
    "result": "created",
    "data": {
        "ruc": "20209999980"
    }
}

Referencia de campos

Manejo de Errores

La API responde con códigos de estado HTTP claros y mensajes descriptivos ante cualquier error. Es fundamental que las integraciones manejen adecuadamente estos errores, validando los datos enviados y gestionando respuestas como se muestra a continuación.

{
    "status": 400,
    "label": "Bad Request",
    "description": "Datos inválidos",
    "body": {
        "error": "Bad Request",
        "message": "El cuerpo de la petición contiene datos inválidos o mal formateados.",
        "details": [
            {
                ...
            }
        ]
    }
}

Rate Limiting

Fases de Implementación

Ventajas