Avelt Developer Portal

Overview & Architecture

The Avelt Test B2B API enables enterprise partners to automate certificate retrieval, stream official PDF documents directly into talent management pipelines, receive real-time execution webhooks, and render verifiable badge widgets on third-party web portals.

1. Authentication & Security

All API requests must be authenticated using a Bearer Token in the standard HTTP `Authorization` header. API Keys are managed in your organization’s Developer Dashboard.

HTTP Authorization Header:

Authorization: Bearer av_live_sample_key_1234567890abcdef

GET

2. Query Certificates Endpoint

Retrieve candidate assessment metadata for your organization. Supports single record lookups, candidate search, and bulk paginated queries.

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

Query Parameters:

Parameter	Type	Required	Description
`cert_id`	integer	Optional	Unique certificate ID.
`rut`	string	Optional	Candidate RUT / National ID (e.g., 12345678-K).
`search`	string	Optional	Partial string match on candidate full name.
`max_years`	integer	Optional	Filter out records older than specified years (Default: 3).
`page`	integer	Optional	Page index for paginated results (Default: 1).
`limit`	integer	Optional	Max records per request (Max: 100, Default: 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. Direct Binary PDF Streaming

Stream or download the official binary PDF document directly into your local storage or ATS candidate file.

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. Real-time Webhook Push Notifications

Avelt Test dispatches an automated HTTP POST JSON payload to your configured endpoint whenever a candidate completes an evaluation.

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. Embeddable JavaScript SDK

Render an interactive, official verification card directly on any HTML page using our lightweight widget script.

<!-- 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>