Estado del servicio

GET https://api.afer.pro/api/v1/health

Alias en castellano (v0, sigue operativo): POST https://api.afer.pro/health

Comprueba que la API responde y que tus credenciales son válidas.

La llamada de humo: úsala para verificar conectividad desde tu servidor, para el health check de tu monitorización o para confirmar que unas credenciales recién generadas funcionan antes de integrar nada.

Si envías las cabeceras de API key y son correctas, la respuesta lo confirma; si no envías ninguna, responde igualmente 200 indicando que el servicio está en pie.

Autenticación

Envía tus claves API en las cabeceras X-API-KEY y X-API-SECRET. La cuenta sobre la que se opera se resuelve automáticamente a partir de la clave. Cómo obtener tus claves →

Es el único endpoint que no exige API key. Si la envías, se valida y se refleja en la respuesta.

Parámetros del cuerpo

Este endpoint no necesita parámetros: basta un cuerpo JSON vacío ({}) con tus cabeceras de autenticación.

Ejemplo de petición

curl -X GET 'https://api.afer.pro/api/v1/health' \
  -H 'X-API-KEY: afer_tk_TU_TOKEN' \
  -H 'X-API-SECRET: afer_sk_TU_SECRET'

<?php

$ch = curl_init('https://api.afer.pro/api/v1/health');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-API-KEY: afer_tk_TU_TOKEN',
    'X-API-SECRET: afer_sk_TU_SECRET',
]);

$respuesta = json_decode(curl_exec($ch), true);
curl_close($ch);

const respuesta = await fetch('https://api.afer.pro/api/v1/health', {
  method: 'GET',
  headers: {
    'X-API-KEY': 'afer_tk_TU_TOKEN',
    'X-API-SECRET': 'afer_sk_TU_SECRET'
  }
});

const resultado = await respuesta.json();

Respuesta

200 · application/json

{
    "errorCode": 200,
    "errorMsg": "",
    "data": {
        "status": "ok"
    }
}

Notas

Con credenciales inválidas la respuesta es 401, igual que en el resto de la API: es la forma más barata de validar una API key.