EntrarProbar gratis
Menú de la documentación

Desarrolladores

Autenticación

Cómo autenticarte en la API de Blogenia con una clave pk_live_ en la cabecera Authorization.

Ver como Markdown

Todas las peticiones llevan una clave de API en la cabecera Authorization, con el esquema Bearer.

Cabecera
Authorization: Bearer pk_live_0123456789abcdef0123456789abcdef

La clave

  • Formato: pk_live_ seguido de 32 caracteres hexadecimales.
  • Se crea en el panel, en API. Solo se muestra al crearla. Blogenia guarda únicamente su huella (SHA-256).
  • Puedes tener hasta 10 claves activas. Al revocar una, deja de funcionar al momento en el proceso que la revoca y, como máximo, 30 segundos después en el resto.
  • Cada clave pertenece a tu organización y solo ve sus datos.
  • Las claves son de solo lectura.

Dónde vale

Una clave solo funciona en las tres rutas GET de lectura: GET /blogs/{blogId} (Blogs), GET /blogs/{blogId}/articles y GET /articles/{id} (Artículos). En cualquier otra ruta, la respuesta es 401 con el mensaje «Esta ruta no admite claves de API».

Si la autenticación falla

RespuestaCuándo
401 «Falta el token de acceso»No hay cabecera Authorization: Bearer ….
401 «Clave de API no válida»La clave no existe, está revocada o no tiene el formato pk_live_ + 32 hexadecimales.
403 plan_requiredTu organización está en el plan Free.
403 ORGANIZATION_SUSPENDEDTu organización está suspendida.

Las tres rutas de lectura aceptan peticiones desde cualquier origen (CORS) pero sin cookies ni credenciales. Aun así, cualquiera que abra tu web podría leer la clave. Haz la petición desde tu servidor y entrega el resultado al navegador. Más consejos en Seguridad.

CORS

  • Solo GET y HEAD en las tres rutas de lectura, desde cualquier Origin, sin credenciales.
  • Cabeceras expuestas al navegador: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset y Retry-After.