Изучите весь API до подачи заявки
Документация Engine открыта. Ресурсы, поля и ошибки описаны с примерами, и ничего из этого не спрятано за формой. Когда захотите попробовать вызов, подайте заявку на аккаунт и создайте ключ песочницы.
- Для чтения
- Аккаунт не нужен
- Формат
- Справочник REST с примерами
- Ключи для песочницы
- С одобренным аккаунтом
Начните с запроса
Быстрее всего изучить API, вызвав его. Эти четыре запроса — хороший первый час: проверить, что ключ работает, вывести список имеющегося, создать релиз и подписаться на события.
- Каждый эндпойнт показан с запросом и ответом
- Ошибки перечислены с причиной и способом исправления
- Примеры в песочнице выполняются как написано
Первые запросы
Примеры запросовGET/v1/me
Ответ
{ "id": "acc_5t1m9", "name": "Northfield Audio", "environment": "sandbox"}Справочник по ресурсам
- Релизы
- Создавайте, обновляйте, отправляйте и снимайте релизы вместе с их территориями и датами.
- Треки и файлы
- Добавляйте треки, загружайте аудио и обложки, задавайте участников, коды и сплиты.
- Доставки
- Отправляйте релиз на площадки и следите за каждым направлением от очереди до выхода или отказа.
- Аналитика
- Читайте стримы и загрузки по площадке, территории, релизу, треку и дню.
- Роялти
- Получайте список отчётов, читайте их строки и смотрите, сколько причитается каждому получателю выплат.
- Webhooks
- Зарегистрируйте эндпойнт, выберите получаемые события и просматривайте, что было отправлено.
Быстрый старт в песочнице
- 1
Создайте ключ для песочницы
Подайте заявку на аккаунт и скопируйте ключ в нём после одобрения.
- 2
Сделайте первый запрос
Вызовите /v1/me, передав ключ в заголовке Authorization, чтобы убедиться, что он работает.
- 3
Создайте тестовый релиз
Отправьте релиз с названием и артистом, затем добавьте к нему трек.
- 4
Смоделируйте доставку
Доставьте его в песочнице и наблюдайте за сменой статуса без участия площадок.
Один заголовок, и вы внутри
Аутентификация — это ключ API, передаваемый как bearer-токен. Никакого рукопожатия и никакой сессии, которую нужно поддерживать. Скопируйте это, подставьте свой ключ и запустите.
- Песочница и продакшен используют разные ключи
- Ключ можно отозвать в любой момент
Список ваших релизов
bashcurl https://api.aevorarecords.com/v1/releases \ -H "Authorization: Bearer YOUR_API_KEY"