Portal de Desarrolladores Avelt

Visión General y Arquitectura

La API REST de Avelt Test permite a clientes corporativos automatizar la consulta de evaluaciones, transmitir certificados PDF directamente a sus sistemas internos (ATS), recibir notificaciones en tiempo real vía Webhooks y mostrar credenciales verificables en sitios web externos.

1. Autenticación y Seguridad

Todas las peticiones HTTP deben incluir un Bearer Token en la cabecera `Authorization`. Las llaves de acceso se gestionan desde el panel de la empresa.

Cabecera de Autenticación HTTP:

Authorization: Bearer av_live_sample_key_1234567890abcdef

GET

2. Endpoint de Consulta de Certificados

Obtenga los metadatos de las evaluaciones de su organización. Soporta búsquedas por ID de certificado, RUT/DNI del candidato, búsqueda por nombre y consultas masivas paginadas.

GET https://www.avelt-test.com/v3/public/api/v1/certificate.php

Query Parameters:

Parámetro	Tipo	Requerido	Descripción
`cert_id`	integer	Optional	ID único del certificado.
`rut`	string	Optional	RUT o documento del candidato (Ej: 12345678-K).
`search`	string	Optional	Búsqueda parcial por nombre completo del candidato.
`max_years`	integer	Optional	Filtro de antigüedad máxima en años (Predeterminado: 3).
`page`	integer	Optional	Número de página para resultados paginados (Predeterminado: 1).
`limit`	integer	Optional	Límite de registros por petición (Máx: 100, Predeterminado: 50).

cURL Request Example:

curl -X GET "https://www.avelt-test.com/v3/public/api/v1/certificate.php?search=John&max_years=3" \

     -H "Authorization: Bearer av_live_sample_key_1234567890abcdef"

JSON Response (200 OK):

{
  "success": true,
  "filters_applied": {
    "max_years": 3,
    "candidate_rut": null,
    "candidate_name": "John"
  },
  "pagination": {
    "total_records": 1,
    "current_page": 1,
    "per_page": 50,
    "total_pages": 1
  },
  "data": [
    {
      "certificate_id": 1001,
      "candidate_name": "John Doe",
      "candidate_rut": "12345678-K",
      "company": "ACME Corp",
      "level": "B2 Upper-Intermediate",
      "issue_date": "2026-10-27",
      "expiration_date": "2029-10-27",
      "paid_status": "Si",
      "urls": {
        "pdf_download": "https://www.avelt-test.com/v3/public/api/v1/certificate.php?cert_id=1001&download=true",
        "verification": "https://www.avelt-test.com/v3/public/verify.php?id=1001"
      }
    }
  ]
}

GET

3. Transmisión Directa de PDF (Stream)

Obtenga el flujo binario del archivo PDF oficial directamente para guardarlo en su servidor o adjuntarlo a la ficha del candidato en su ATS.

curl -X GET "https://www.avelt-test.com/v3/public/api/v1/certificate.php?cert_id=1001&download=true" \

     -H "Authorization: Bearer av_live_sample_key_1234567890abcdef" \

     --output "Certificate_1001.pdf"

POST

4. Notificaciones Push (Webhooks) en Tiempo Real

El motor de Webhooks de Avelt Test envía un paquete JSON mediante HTTP POST a su servidor tan pronto como un candidato finaliza una evaluación.

Sample HTTP Payload (JSON):

{
  "event": "certificate.issued",
  "timestamp": "2026-10-27T21:00:00+00:00",
  "company": "ACME Corp",
  "certificate": {
    "id": 1001,
    "candidate_name": "John Doe",
    "candidate_rut": "12345678-K",
    "level": "B2 Upper-Intermediate",
    "issue_date": "2026-10-27",
    "expiration_date": "2029-10-27",
    "urls": {
      "pdf_download": "https://www.avelt-test.com/v3/public/api/v1/certificate.php?cert_id=1001&download=true",
      "verification": "https://www.avelt-test.com/v3/public/verify.php?id=1001"
    }
  }
}

5. SDK Widget Embebible JavaScript

Muestre una tarjeta de verificación oficial e interactiva en cualquier página web HTML incluyendo este código ligero:

<!-- HTML Container -->
<div data-avelt-cert="1001" data-api-key="av_live_sample_key_1234567890abcdef" data-theme="light"></div>

<!-- Avelt SDK Script -->
<script src="https://www.avelt-test.com/v3/public/sdk/embed.js" async></script>