Запустіть дистрибуцію у власному продукті
Engine — це API Aevora. Створюйте релізи, доставляйте їх у магазини, читайте аналітику та ведіть облік роялті через REST, у продукті, яким ваші клієнти вже користуються. Документація відкрита, а для розробки є пісочниця.
- Інтерфейс
- REST і JSON
- Автентифікація
- API-ключі, окремий набір для кожного середовища
- Пісочниця
- Тестові доставки без участі магазинів
Чотири виклики ведуть реліз від чернетки до звіту
API повторює шлях, який реліз проходить на панелі керування: створити, доставити, читати цифри в міру надходження, а потім прочитати звіт. Оберіть виклик, щоб побачити, що ви надсилаєте і що отримуєте у відповідь.
- Запити та відповіді — у форматі JSON
- Помилка вказує поле, яке не пройшло перевірку, і причину
- Ті самі виклики працюють у пісочниці та в робочому середовищі
API Engine
Приклади запитівPOST/v1/releases
Тіло запиту
{ "title": "Night Drive", "artist": "Mira Kaya", "label": "Northfield Audio", "release_date": "2027-03-12"}Відповідь
{ "id": "rel_8f2k1", "status": "draft", "upc": null}Що є навколо ендпойнтів
Виклики — найкоротша частина інтеграції. Ось те, що підтримує її роботу, коли ніхто не стежить.
- Webhooks
- Отримуйте подію, коли змінюється стан доставки, реліз виходить або звіт готовий, тож опитувати API не потрібно.
- Ключі ідемпотентності
- Надішліть ключ із запитом на запис, і повторна спроба поверне перший результат, а не створить другий реліз.
- Пагінація
- Списки повертають курсор. Передайте його назад, щоб отримати наступну сторінку, щоразу в тому самому порядку.
- Пісочниця
- Окреме середовище з власними ключами. Доставки проходять від початку до кінця й зупиняються перед будь-яким магазином.
- Версії
- Версія є частиною шляху. Зміна, що ламає сумісність, виходить під новою версією, тож та, з якою ви працюєте, лишається незмінною.
- Ліміти частоти
- Кожна відповідь повідомляє, скільки ліміту залишилося, а обмежений запит підказує, коли спробувати знову.
Від першого ключа до доставки в робочому середовищі
- 1
Отримайте ключі
Подайте заявку на акаунт. Після схвалення створіть ключ пісочниці.
- 2
Розробляйте в пісочниці
Створюйте релізи та запускайте тестові доставки, доки інтеграція не оброблятиме кожен стан.
- 3
Запросіть доступ до робочого середовища
Розкажіть, що ви створюєте. Ми переглянемо запит і видамо робочі ключі.
- 4
Доставка
Перейдіть на робочий ключ, і ті самі виклики дійдуть до справжніх магазинів.