Documentación del API para Partners Certena

Postman collection → OpenAPI spec →

Introduction

Documentación oficial para la integración con partners.

    Esta documentación proporciona toda la información necesaria para trabajar con nuestra API.

    Al desplazarse, verá ejemplos de código para trabajar con la API en diferentes lenguajes de programación en el área oscura a la derecha (o como parte del contenido en dispositivos móviles).
    Puede cambiar el idioma con las pestañas de la esquina superior derecha (o desde el menú de navegación de la esquina superior izquierda en dispositivos móviles).

Authenticating requests

To authenticate requests, include a key header with the value "{YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Authorization

Endpoints para el manejo del acceso al API de los partners a los servicios de Certena.

Obtener token de acceso para partners.

GET
https://api-dev.certena.ai
/api/partners/auth
requires authentication

Este endpoint permite a los partners autenticarse utilizando su API Key y Secret Key. La IP desde la que se realiza la petición debe estar en la whitelist del partner.

Headers

key
Example:
{YOUR_AUTH_KEY}
Authorization
Example:
Basic base64_encode({api-key}:{api-secret})
Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://api-dev.certena.ai/api/partners/auth" \
    --header "key: {YOUR_AUTH_KEY}" \
    --header "Authorization: Basic base64_encode({api-key}:{api-secret})" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
    "token_type": "bearer",
    "expires_in": 3600,
    "partner": {
        "id": 1,
        "name": "Partner Demo"
    }
}
{
    "error": "Unauthorized"
}
{
    "error": "ip_not_allowed"
}

Refrescar token.

POST
https://api-dev.certena.ai
/api/partners/refresh
requires authentication

Obtiene un nuevo token JWT sin necesidad de reautenticar.

Headers

key
Example:
{YOUR_AUTH_KEY}
Authorization
Example:
Bearer {token_JWT}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request POST \
    "https://api-dev.certena.ai/api/partners/refresh" \
    --header "key: {YOUR_AUTH_KEY}" \
    --header "Authorization: Bearer {token_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
    "token_type": "bearer",
    "expires_in": 3600
}

Cerrar sesión (invalidar token).

POST
https://api-dev.certena.ai
/api/partners/logout
requires authentication

Invalida el token JWT actual.

Headers

key
Example:
{YOUR_AUTH_KEY}
Authorization
Example:
Bearer {token_JWT}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request POST \
    "https://api-dev.certena.ai/api/partners/logout" \
    --header "key: {YOUR_AUTH_KEY}" \
    --header "Authorization: Bearer {token_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "message": "Successfully logged out"
}