Przeczytaj całe API, zanim złożysz wniosek
Dokumentacja Engine jest otwarta. Zasoby, pola i błędy są opisane z przykładami, a nic z tego nie jest ukryte za formularzem. Gdy zechcesz wypróbować wywołanie, złóż wniosek o konto i utwórz klucz sandboxa.
- Do czytania
- Konto nie jest potrzebne
- Format
- Dokumentacja REST z przykładami
- Klucze sandbox
- Z zatwierdzonym kontem
Zacznij od żądania
Najszybszy sposób na poznanie API to wywołanie go. Te cztery żądania to dobra pierwsza godzina: sprawdź, czy klucz działa, wyświetl, co jest, utwórz wydanie i zasubskrybuj zdarzenia.
- Każdy endpoint jest pokazany z żądaniem i odpowiedzią
- Błędy są wymienione wraz z przyczyną i poprawką
- Przykłady działają na sandboxie w takiej postaci, w jakiej je podano
Pierwsze żądania
Przykładowe zapytaniaGET/v1/me
Odpowiedź
{ "id": "acc_5t1m9", "name": "Northfield Audio", "environment": "sandbox"}Dokumentacja według zasobów
- Wydania
- Twórz, aktualizuj, wysyłaj i wycofuj wydania, wraz z ich terytoriami i datami.
- Utwory i pliki
- Dodawaj utwory, przesyłaj audio i okładki oraz ustawiaj autorów, kody i podziały.
- Dostarczenia
- Wyślij wydanie do sklepów i śledź każdy cel od kolejki do aktywnego lub odrzuconego.
- Analityka
- Odczytuj streamy i pobrania według sklepu, terytorium, wydania, utworu i dnia.
- Tantiemy
- Wyświetlaj rozliczenia, odczytuj ich wiersze i sprawdzaj, ile należy się każdemu odbiorcy.
- Webhooki
- Zarejestruj endpoint, wybierz zdarzenia, które otrzymuje, i sprawdź, co zostało wysłane.
Szybki start, na sandboxie
- 1
Utwórz klucz sandbox
Złóż wniosek o konto i po zatwierdzeniu skopiuj z niego klucz.
- 2
Wyślij pierwsze żądanie
Wywołaj /v1/me z kluczem w nagłówku Authorization, aby potwierdzić, że działa.
- 3
Utwórz testowe wydanie
Wyślij wydanie z tytułem i artystą, a potem dodaj do niego utwór.
- 4
Zasymuluj dostarczenie
Dostarcz je w sandboxie i obserwuj zmiany statusu, bez udziału sklepu.
Jeden nagłówek i jesteś w środku
Uwierzytelnianie to klucz API wysyłany jako token bearer. Nie ma wymiany uzgodnień ani sesji, którą trzeba utrzymywać. Skopiuj to, wstaw swój klucz i uruchom.
- Sandbox i produkcja używają osobnych kluczy
- Klucz można unieważnić w każdej chwili
Wyświetl swoje wydania
bashcurl https://api.aevorarecords.com/v1/releases \ -H "Authorization: Bearer YOUR_API_KEY"