Přečtěte si celé API ještě před podáním žádosti

Dokumentace Engine je otevřená. Zdroje, pole i chyby jsou popsány s příklady a nic z toho není za formulářem. Až si budete chtít zkusit volání, požádejte o účet a vytvořte klíč sandboxu.

Ke čtení
Účet není potřeba
Formát
Reference REST s příklady
Klíče pro sandbox
Se schváleným účtem

Začněte požadavkem

Nejrychlejší způsob, jak API pochopit, je zavolat ho. Tyto čtyři požadavky jsou dobrou první hodinou: ověřte, že váš klíč funguje, vypište, co tam je, vytvořte vydání a přihlaste se k odběru událostí.

  • Každý endpoint je ukázán s požadavkem a odpovědí
  • Chyby jsou uvedeny s příčinou a opravou
  • Příklady běží v sandboxu tak, jak jsou napsané

První požadavky

Ukázkové požadavky

GET/v1/me

Odpověď

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

Reference podle zdroje

Vydání
Vytvářejte, upravujte, odesílejte a stahujte vydání, včetně jejich území a dat.
Skladby a soubory
Přidávejte skladby, nahrávejte zvuk a artwork a nastavujte údaje o tvůrcích, kódy a splity.
Doručení
Odešlete vydání do obchodů a sledujte každý cíl od zařazení do fronty po zveřejnění nebo odmítnutí.
Analytika
Čtěte streamy a stažení podle obchodu, území, vydání, skladby a dne.
Royalties
Vypisujte vyúčtování, čtěte jejich řádky a zjistěte, kolik má každý příjemce nárok.
Webhooky
Zaregistrujte koncový bod, vyberte události, které přijímá, a prohlédněte si, co bylo odesláno.

Rychlý start, v sandboxu

  1. 1

    Vytvořte klíč pro sandbox

    Požádejte o účet a po schválení z něj zkopírujte klíč.

  2. 2

    Pošlete první požadavek

    Zavolejte /v1/me s klíčem v hlavičce Authorization a ověřte, že funguje.

  3. 3

    Vytvořte testovací vydání

    Odešlete vydání s názvem a interpretem a pak k němu přidejte skladbu.

  4. 4

    Nasimulujte doručení

    Doručte ho v sandboxu a sledujte, jak se mění stav, bez zapojení obchodu.

Jedna hlavička a jste uvnitř

Autentizace je klíč API poslaný jako bearer token. Žádné vyjednávání ani relace, kterou by bylo třeba udržovat. Zkopírujte to, vložte svůj klíč a spusťte.

  • Sandbox a produkce používají oddělené klíče
  • Klíč lze kdykoli zrušit

Vypište svá vydání

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

Otázky k dokumentaci

Ne. Reference je veřejná. Účet potřebujete jen tehdy, když chcete klíč.

Endpointy a odpovědi jsou stejné. Doručení v sandboxu se zastaví před jakýmkoli obchodem a data ze sandboxu jsou oddělena od vašeho živého katalogu.

Doplnění se uvádějí v seznamu změn. Změna, která něco rozbíjí, vychází pod novou verzí v cestě, takže verze, proti které jste stavěli, zůstává beze změny.

Nejdřív číst, pak poslat požadavek