Hacer la primera petición y ver qué recursos tiene tu servicio
Pide la lista de recursos con tu clave, comprueba la respuesta y reconoce el error de una clave equivocada.
En esta página4 secciones
Antes de empezar
- Una clave de API activa con permiso sobre el recurso. Habilitar la API y gestionar sus claves de acceso
- Las variables
BEPLY_URLyBEPLY_TOKENpreparadas en tu terminal o en el servidor.
Pedir la lista de recursos
GET/api/3/
Devuelve, ordenados alfabéticamente, todos los recursos de datos y funciones que tiene tu servicio. Depende de los módulos activos y no se filtra por los permisos de la clave: que un recurso aparezca no significa que tu clave pueda usarlo.
curl -s "$BEPLY_URL/api/3/" \
-H "X-Auth-Token: $BEPLY_TOKEN"const res = await fetch(`${process.env.BEPLY_URL}/api/3/`, {
headers: { 'X-Auth-Token': process.env.BEPLY_TOKEN },
})
const { resources } = await res.json()
console.log(resources.length, resources.includes('clientes'))<?php
$ch = curl_init(getenv('BEPLY_URL') . '/api/3/');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['X-Auth-Token: ' . getenv('BEPLY_TOKEN')],
]);
$res = json_decode(curl_exec($ch), true);
print_r($res['resources']);Comprueba el resultado
HTTP 200 y un JSON con la clave resources. Busca en la lista los recursos que vas a usar antes de programar contra ellos.
{
"resources": [
"agentes",
"albaranclientes",
"clientes",
"crearFacturaCliente",
"…"
]
}Ejemplo fallido
Sin cabecera o con una clave errónea la respuesta es HTTP 401. Un nombre de recurso mal escrito (por ejemplo facturasclientes) devuelve 404 con una clave de acceso completo y 403 con una clave por recurso.
{
"status": "error",
"message": "Clave de API no válida"
}