Prowadź dystrybucję z poziomu własnego produktu

Engine to API Aevora. Twórz wydania, dostarczaj je do sklepów, odczytuj analitykę i obsługuj tantiemy przez REST, z produktu, z którego Twoi klienci już korzystają. Dokumentacja jest publiczna, a do budowania dostępny jest sandbox.

Interfejs
REST i JSON
Uwierzytelnianie
Klucze API, osobny zestaw dla każdego środowiska
Sandbox
Testowe dostarczenia, bez udziału sklepów

Cztery wywołania prowadzą wydanie od wersji roboczej do rozliczenia

API odtwarza drogę wydania w panelu: tworzysz je, dostarczasz, odczytujesz liczby w miarę ich napływania, a potem odczytujesz rozliczenie. Wybierz wywołanie, aby zobaczyć, co wysyłasz i co dostajesz w odpowiedzi.

  • Żądania i odpowiedzi mają format JSON
  • Błąd wskazuje pole, które zawiodło, i powód
  • Te same wywołania działają w sandboxie i na produkcji

API Engine

Przykładowe zapytania

POST/v1/releases

Treść zapytania

{  "title": "Night Drive",  "artist": "Mira Kaya",  "label": "Northfield Audio",  "release_date": "2027-03-12"}

Odpowiedź

{  "id": "rel_8f2k1",  "status": "draft",  "upc": null}

Co otacza endpointy

Wywołania to krótka część integracji. Oto elementy, dzięki którym działa ona, gdy nikt jej nie pilnuje.

Webhooki
Otrzymuj zdarzenie, gdy zmienia się stan dostarczenia, wydanie staje się aktywne albo rozliczenie jest gotowe, bez konieczności odpytywania.
Klucze idempotentności
Wyślij klucz z żądaniem zapisu, a ponowna próba zwróci pierwszy wynik zamiast tworzyć drugie wydanie.
Paginacja
Listy zwracają kursor. Przekaż go z powrotem, aby pobrać następną stronę, zawsze w tej samej kolejności.
Sandbox
Osobne środowisko z własnymi kluczami. Dostarczenia przebiegają od początku do końca i zatrzymują się przed każdym sklepem.
Wersjonowanie
Wersja jest częścią ścieżki. Zmiana łamiąca zgodność pojawia się w nowej wersji, więc ta, na której budujesz, pozostaje bez zmian.
Limity żądań
Każda odpowiedź informuje, ile limitu zostało, a żądanie ograniczone informuje, kiedy spróbować ponownie.

Od pierwszego klucza do dostarczenia na produkcji

  1. 1

    Zdobądź klucze

    Złóż wniosek o konto. Po zatwierdzeniu utwórz klucz sandboxa.

  2. 2

    Buduj na sandboxie

    Twórz wydania i uruchamiaj testowe dostarczenia, aż integracja będzie obsługiwać każdy stan.

  3. 3

    Poproś o dostęp produkcyjny

    Napisz, co budujesz. Sprawdzimy to i wydamy klucze produkcyjne.

  4. 4

    Dostarcz

    Przełącz się na klucz produkcyjny, a te same wywołania dotrą do prawdziwych sklepów.

Pytania o Engine

Nie. Dokumentacja jest publiczna. Konto, które zakładamy na podstawie wniosku, jest potrzebne dopiero wtedy, gdy chcesz mieć klucz.

Tak. Wydanie utworzone przez API pojawia się w panelu, a wydanie utworzone w panelu można odczytać i dostarczyć przez API.

Dostarczenie przechodzi przez te same stany co prawdziwe i wysyła te same webhooki, ale nic nie jest wysyłane do sklepu.

Wyślij pierwsze żądanie w sandboxie