Desarrolladores: integrar tu software con la API de Beply

Autenticación

Cómo autenticar llamadas a la API de Beply con credenciales de integración.

Actualizado el 22 de octubre de 2026

Autenticar las peticiones a la API con una clave

Cada petición a la API debe llevar una clave activa. Esta guía explica cómo crearla con los permisos justos, cómo enviarla y qué hacer si la API la rechaza.

Aplicabilidad: API versión 3 · Plan Profesional, con la API activada en el servicio.

Crear la clave

La activación de la API y el alta de claves se hacen en el programa por un administrador: sigue Habilitar la API y gestionar sus claves de acceso. Al crear la clave decide:

  • Acceso completo: permite todos los recursos y métodos. Úsalo solo si la integración lo necesita de verdad.
  • Acceso por recurso: para cada recurso se permiten por separado lectura (GET), alta (POST), modificación (PUT) y borrado (DELETE). Es la opción recomendada.

Enviar la clave

export BEPLY_URL="https://<TU_SERVICIO>.beply.es"
export BEPLY_TOKEN="<TU_CLAVE_API>"
curl -s "$BEPLY_URL/api/3/clientes?limit=1" -H "Token: $BEPLY_TOKEN"

La API lee la cabecera X-Auth-Token y, si no existe, la cabecera Token. Usa una de las dos, nunca la clave en la URL.

Comprueba el resultado

HTTP 200 con un array JSON (puede estar vacío). La lista completa de recursos sin filtrar por permisos se obtiene con GET /api/3/.

Si algo falla

SíntomaCausaAcción segura
HTTP 409 «API desactivada. Puede activarla desde el panel de control»La API no está activada en el servicio.Un administrador la activa (guía enlazada arriba). Comprueba que el plan es Profesional.
HTTP 401 «Clave de API no válida»Cabecera ausente, clave errónea o desactivada.Revisa la variable de entorno y que la clave siga activa. No reintentes en bucle.
HTTP 403 con mensaje de permisoLa clave no tiene ese recurso o ese método.Añade solo el permiso necesario a esa clave.
HTTP 429 «…se ha bloqueado durante 10 minutos el acceso desde su IP»Cinco fallos de autenticación o permiso desde la misma IP en 10 minutos.Corrige la causa y espera 10 minutos antes de repetir.

Buenas prácticas

  • Una clave por integración y por entorno; así puedes desactivar una sin afectar a otras.
  • Guarda la clave como secreto del servidor; nunca en el navegador, en un repositorio ni en capturas.
  • Si sospechas que una clave se ha expuesto, desactívala y crea otra.

Siguiente paso

Primera petición y formatos.

Captura ampliada

Abrir en otra pestaña

¿Te ha resultado útil esta página?

¿Aún tienes dudas?

Habla con nuestro equipo y te resolvemos cualquier duda al instante.