콘텐츠로 이동

Autenticación y claves de API

La API pública utiliza claves de API Bearer con el prefijo spk_.

Authorization: Bearer spk_...

Cada clave de API está limitada a una sola marca. La propia clave determina la marca a la que apuntan los endpoints /v1/brand/*; no se puede indicar otra marca en el cuerpo de la solicitud.

Solo los propietarios de la marca pueden generar y emitir claves de API.

Según el punto final, se verifican los siguientes alcances:

  • brands:read, brands:write
  • connections:read
  • publishing:read, publishing:write
  • comments:read, comments:write, comments:moderate
  • analytics:read
  • webhooks:read, webhooks:write

Si una clave de API carece de los alcances requeridos, el servidor devuelve 403 insufficient_scope.

  • /
  • /v1/health
  • /v1/docs
  • /v1/openapi.json

Las marcas con el plan Free pueden tener 1 clave de API activa y realizar 1,000 solicitudes de API por mes calendario (UTC). Las marcas con el plan Growth pueden tener varias claves activas y están sujetas a una política de uso justo.

Tanto las solicitudes correctas como las fallidas realizadas después de una autenticación válida cuentan para la cuota del plan Free. Las comprobaciones de estado, la documentación de la API, las solicitudes del esquema OpenAPI y las solicitudes con claves no válidas no se incluyen en el recuento.

  • Guarde las claves en variables de entorno o en un servicio de gestión de secretos.
  • Nunca incluya claves en el código del navegador del lado del cliente.
  • Oculte las claves en las salidas de registro (logs).
  • Desactive las claves que no utilice y rótelas por claves nuevas.
  • Separe las claves por script automatizado para distinguir los registros de acceso.