Вивчіть увесь API до подання заявки

Документація Engine відкрита. Ресурси, поля й помилки описано з прикладами, і нічого з цього не сховано за формою. Коли захочете спробувати виклик, подайте заявку на акаунт і створіть ключ пісочниці.

Для читання
Обліковий запис не потрібен
Формат
Довідник REST із прикладами
Ключі пісочниці
Зі схваленим акаунтом

Почніть із запиту

Найшвидший спосіб прочитати API — викликати його. Ці чотири запити добре підходять для першої години: перевірте, що ключ працює, перегляньте наявне, створіть реліз і підпишіться на події.

  • Для кожного ендпойнта показано запит і відповідь
  • Помилки наведено з причиною та виправленням
  • Приклади виконуються в пісочниці в тому вигляді, як написані

Перші запити

Приклади запитів

GET/v1/me

Відповідь

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

Довідник за ресурсами

Релізи
Створюйте, оновлюйте, надсилайте та знімайте з публікації релізи разом з їхніми територіями та датами.
Треки та ресурси
Додавайте треки, завантажуйте аудіо й обкладинки, вказуйте авторів, коди та спліти.
Доставки
Надсилайте реліз у магазини й стежте за кожним призначенням від «у черзі» до «доступний» або «відхилено».
Аналітика
Читайте стріми та завантаження за магазином, територією, релізом, треком і днем.
Роялті
Отримуйте список звітів, читайте їхні рядки й дивіться, скільки винні кожному отримувачу.
Webhooks
Зареєструйте ендпойнт, оберіть події, які він отримує, і перегляньте, що було надіслано.

Швидкий старт у пісочниці

  1. 1

    Створіть ключ для пісочниці

    Подайте заявку на акаунт і скопіюйте ключ у ньому після схвалення.

  2. 2

    Зробіть перший запит

    Викличте /v1/me з ключем у заголовку Authorization, щоб переконатися, що він працює.

  3. 3

    Створіть тестовий реліз

    Надішліть реліз з назвою та артистом, а потім додайте до нього трек.

  4. 4

    Змоделюйте доставку

    Доставте його в пісочниці й дивіться, як змінюється статус, без участі магазинів.

Один заголовок, і ви всередині

Автентифікація — це API-ключ, що надсилається як bearer-токен. Ні рукостискання, ні сесії, яку треба підтримувати. Скопіюйте це, підставте свій ключ і запустіть.

  • Пісочниця та робоче середовище використовують окремі ключі
  • Ключ можна відкликати в будь-який час

Перегляньте свої релізи

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

Питання про документацію

Ні. Довідник публічний. Акаунт потрібен лише тоді, коли вам потрібен ключ.

Ендпойнти та відповіді однакові. Доставки в пісочниці зупиняються перед будь-яким магазином, а дані пісочниці зберігаються окремо від вашого робочого каталогу.

Доповнення зазначаються в журналі змін. Зміна, що ламає сумісність, виходить під новою версією в шляху, тож версія, під яку ви писали, залишається без змін.

Спершу прочитайте, потім зробіть запит