Lee toda la API antes de solicitar acceso

La referencia de Engine es abierta. Los recursos, campos y errores están documentados con ejemplos, y nada queda tras un formulario. Cuando quieras probar una llamada, solicita una cuenta y crea una clave de sandbox.

Para leer
No se necesita cuenta
Formato
Referencia REST con ejemplos
Claves de sandbox
Con una cuenta aprobada

Empieza con una solicitud

La forma más rápida de leer una API es llamarla. Estas cuatro solicitudes son una buena primera hora: comprobar que tu clave funciona, listar lo que hay, crear un lanzamiento y suscribirte a eventos.

  • Cada endpoint se muestra con una solicitud y una respuesta
  • Los errores se listan con su causa y su solución
  • Los ejemplos se ejecutan en el sandbox tal como están escritos

Primeras solicitudes

Solicitudes de ejemplo

GET/v1/me

Respuesta

{  "id": "acc_5t1m9",  "name": "Northfield Audio",  "environment": "sandbox"}

La referencia, por recurso

Lanzamientos
Crea, actualiza, envía y da de baja lanzamientos, con sus territorios y fechas.
Pistas y archivos
Añade pistas, sube audio y portadas, y define créditos, códigos y splits.
Entregas
Envía un lanzamiento a las tiendas y sigue cada destino desde en cola hasta publicado o rechazado.
Analíticas
Lee streams y descargas por tienda, territorio, lanzamiento, pista y día.
Regalías
Lista liquidaciones, lee sus líneas y consulta lo que se debe a cada beneficiario.
Webhooks
Registra un endpoint, elige los eventos que recibe y revisa lo que se envió.

Inicio rápido, sobre el sandbox

  1. 1

    Crea una clave de sandbox

    Solicita una cuenta y, cuando se apruebe, copia la clave desde ella.

  2. 2

    Haz tu primera solicitud

    Llama a /v1/me con la clave en la cabecera Authorization para confirmar que funciona.

  3. 3

    Crea un lanzamiento de prueba

    Envía un lanzamiento con un título y un artista y luego añádele una pista.

  4. 4

    Simula una entrega

    Entrégalo en el sandbox y observa cómo cambia el estado, sin ninguna tienda de por medio.

Una cabecera y ya estás dentro

La autenticación es una clave de API enviada como bearer token. No hay handshake ni sesión que mantener activa. Copia esto, sustituye tu clave y ejecútalo.

  • El sandbox y producción usan claves distintas
  • Una clave se puede revocar en cualquier momento

Lista tus lanzamientos

bash
curl https://api.aevorarecords.com/v1/releases \  -H "Authorization: Bearer YOUR_API_KEY"

Preguntas sobre la documentación

No. La referencia es pública. Solo necesitas una cuenta cuando quieras una clave.

Los endpoints y las respuestas son los mismos. Las entregas del sandbox se detienen antes de llegar a cualquier tienda, y los datos del sandbox se mantienen separados de tu catálogo real.

Las novedades se anotan en el registro de cambios. Un cambio incompatible se publica bajo una nueva versión en la ruta, de modo que la versión con la que desarrollaste se mantiene tal cual.

Primero lee, luego haz una solicitud