DOCUMENTACIÓN DE LA API

API REST pública. Autenticación por clave, documentada con OpenAPI.

Lee tu catálogo de OGRECORDS y gestiona Smartlinks y borradores de releases de forma programática, a través de una API REST sencilla. Autentícate con un API-Key con alcance desde tu panel de control. Acceso anticipado bajo solicitud.

Referencia de la APIGestionar API-KeysSolicitar acceso anticipado

Resumen: API REST, claves con alcance, límites de tasa, OpenAPI

REST de lectura + escritura

Lee releases, tracks, Smartlinks y estadísticas — y crea o edita tus Smartlinks y borradores de releases — a través de HTTPS simple. Respuestas JSON, paginación con límite/desplazamiento, esquemas predecibles. La distribución y el envío quedan fuera de la API.

API-Keys con alcance

Autentícate con una clave ogr_pk_ como token de portador o en el encabezado X-API-Key. Cada clave tiene alcances explícitos — read:releases, read:smartlinks, read:stats, write:smartlinks, write:releases — y puede rotarse y revocarse en cualquier momento desde el panel de control.

Límites de tasa + encabezados

Cada respuesta incluye X-RateLimit-Limit, X-RateLimit-Remaining y X-RateLimit-Reset. Si se supera la cuota, se devuelve un 429 con Retry-After. Las claves gratuitas obtienen 1.000 solicitudes/día, las claves Business 100.000.

OpenAPI 3.0 autoalojada

La especificación completa legible por máquina se encuentra en /api/v1/public/openapi.json y se renderiza como una referencia interactiva en esta página — sin hosts de documentación de terceros, sin llamadas externas.

RESUMEN DE ENDPOINTS

Los endpoints para el lanzamiento.

Cada endpoint se autentica con una API key de alcance limitado y se sirve desde https://api.og-records.com. Endpoints de lectura más escrituras restringidas al propietario para Smart Links y releases en borrador — la distribución y el envío no están expuestos.

Lanzamientos

  • GET/api/v1/public/releasesLista tus releases. Paginación con límite y desplazamiento.
  • GET/api/v1/public/releases/{id}Un solo release por id.
  • POST/api/v1/public/releasesCrear borrador de release (write:releases). Se requiere KYC + Onboarding.
  • PATCH/api/v1/public/releases/{id}Actualizar metadatos del borrador (write:releases). Solo borradores previos al envío.
  • DELETE/api/v1/public/releases/{id}Eliminar borrador de release (write:releases).

Tracks

  • GET/api/v1/public/tracks?release_id={id}Tracks de un release que te pertenece.
  • GET/api/v1/public/tracks/{id}Un track individual por ID.

Smartlinks

  • GET/api/v1/public/smartlinksLista tus Smartlinks.
  • POST/api/v1/public/smartlinksCrear un Smartlink para un release propio (write:smartlinks).
  • PATCH/api/v1/public/smartlinks/{id}Actualizar uno de tus Smartlinks (write:smartlinks).
  • DELETE/api/v1/public/smartlinks/{id}Desactivar un Smartlink (write:smartlinks).

Estadísticas y especificaciones

  • GET/api/v1/public/stats/release/{id}Streams, oyentes y guardados con desglose por DSP y país. range = 7d, 14d, 30d, 90d, 1y o ytd.
  • GET/api/v1/public/openapi.jsonEl documento OpenAPI 3.0. Público y almacenable en caché, no se necesita clave.

Artistas e ingresos

  • GET/api/v1/public/artistsLista tus artistas del roster (read:artists).
  • GET/api/v1/public/earnings/balanceTu saldo de USD en la billetera (read:earnings).
WEBHOOKS

Recibe notificaciones cuando un release cambie de estado.

Registra un endpoint HTTPS y te enviaremos un evento JSON firmado tan pronto como uno de tus releases sea entregado, rechazado o retirado. Puedes gestionar los endpoints en el Dashboard; cada uno recibe su propio secreto de firma, que se muestra una sola vez.

Eventos de lanzamiento

  • release.delivered — el release ha sido entregado a las tiendas.
  • release.rejected — una tienda o un paso de control de calidad ha rechazado el release.
  • release.takedown — el release ha sido retirado.
  • release.live — el release ya está disponible en las tiendas.

Cada entrega lleva estos encabezados

  • X-Webhook-Signature — HMAC-SHA256 en hexadecimal en minúsculas del cuerpo de la solicitud sin procesar, usando tu secreto de firma como clave.
  • X-Webhook-Timestamp — hora de envío ISO-8601, igual a created_at en el cuerpo.
  • X-Webhook-Event — el nombre del evento, por ejemplo, release.delivered.
  • X-Webhook-Id — un ID único para esta entrega.

El payload es un cuerpo JSON con id, event, created_at y un objeto data que contiene release_id. Para verificar, recalcula HMAC-SHA256 sobre el cuerpo sin procesar exacto con tu secreto de firma y compáralo de forma segura en cuanto al tiempo con X-Webhook-Signature; luego verifica que X-Webhook-Timestamp esté dentro de unos cinco minutos para rechazar repeticiones.

Las entregas fallidas se reintentan con retroceso exponencial. Después de 15 fallos consecutivos, el endpoint se desactiva automáticamente y debes registrarlo de nuevo para continuar.

Administrar webhooks en tu panel de control.

AUTENTICACIÓN

API Keys con scopes.

Crea una clave en tu panel de control y envíala como encabezado Authorization: Bearer ogr_pk_… o en el encabezado X-API-Key. Cada clave tiene un scope — read:releases, read:smartlinks, read:stats, write:smartlinks, write:releases — para que una integración solo obtenga lo que necesita. Las claves se pueden rotar y revocar en cualquier momento. El acceso de escritura tiene un scope de propietario y nunca activa la distribución; OAuth no forma parte de este lanzamiento.

LÍMITES DE TASA

Lo que tu clave puede hacer.

Gratis
1,000 solicitudes / día

Estándar para cada nueva clave. Adecuado para paneles de control, sincronizaciones cron y prototipos.

Negocio
100,000 solicitudes / día

Cuota diaria más alta para integraciones de producción. Previa solicitud.

Cada respuesta contiene X-RateLimit-Limit, X-RateLimit-Remaining y X-RateLimit-Reset. Si se agota la cuota diaria, se devuelve 429 con el encabezado Retry-After — los segundos hasta el restablecimiento de la ventana.

ACCESO ANTICIPADO

Construye sobre tu catálogo.

La API pública está en acceso anticipado. Escríbenos qué quieres construir y activaremos las API Keys para tu cuenta.

Solicitar acceso anticipadoLeer referencia