Voliteľné API projektu
Zobrazte dohodnuté operácie aplikácie, keď ich potrebujete
Prekontrolujte rozsah API pre daný projekt a odlíšte plánované cesty od už existujúcich koncových bodov.
Používajte API ako jednu z definovaných možností projektu.
- Skontrolujte túto možnosť
Skontrolujte dostupnosť API a príslušnú ponuku projektu.
- Definujte rozsah trasy
Objasnite obchodné operácie, ktoré má API sprístupňovať.
- Skontrolujte katalóg trás
Zobrazte metódu, cestu a plánovaný alebo aktuálny stav každej trasy.
Pridajte API, keď ho bude váš projekt potrebovať
API projektu je voliteľnou súčasťou ponuky. Pred aktiváciou si prečítajte jeho rozsah a podmienky, namiesto toho, aby ste automaticky predpokladali, že ho obsahuje každá aplikácia.
Nástroje API organizujú navrhnuté trasy podľa obchodnej oblasti. Vysvetlenia pomáhajú definovať, čo by mala každá operácia robiť ešte pred jej implementáciou.
Rozlišujte zamýšľané trasy od funkčných koncových bodov
Pripravte prístup pre iný systém. Projekt môže potrebovať ďalšiu aplikáciu na používanie jeho obchodných operácií. Skontrolujte voliteľný rozsah API a ponuku, namiesto toho, aby ste predpokladali, že každá funkcia bude automaticky sprístupnená. Dohodnuté operácie definujú, ku čomu má integrácia pristupovať.
Skontrolujte katalóg trás. Katalóg zobrazuje metódu, cestu, popis a stav každej trasy. Pomáha odlíšiť navrhovanú oblasť od koncových bodov registrovaných ako aktívnych. Ide o praktickú referenciu pri príprave na používanie API.
Vyberte správny smer integrácie. Používanie API od iného poskytovateľa a sprístupňovanie vašej vlastnej aplikácie sú odlišné potreby. Externé pripojenia pokrývajú prvú možnosť; projektové API pokrýva dohodnuté sprístupnenie. Vyberte si spôsob, ktorý zodpovedá požadovanej obchodnej výmene.
Rozlíšite, či je API verejne dostupné, od vonkajšieho pripojenia.
API projektu odhaľuje dohodnuté operácie vašej aplikácie. Externé pripojenie popisuje, ako vaša aplikácia používa inú službu; slúžia na rôzne účely.
Použite katalóg trás na kontrolu metódy, cesty a či je daný koncový bod naplánovaný alebo aktívny. Táto prezentácia neaktivuje API pre váš projekt.
Posúďte možnosť API podľa konkrétnej potreby
Určte, kto bude údaje projektu využívať a aké operácie si táto integrácia vyžaduje. Pomôže to odlíšiť voliteľný rozsah API od prepojenia s existujúcou externou službou.
Pri oprávnenom projekte si prezrite plánované cesty a stav ich tvorby. Skôr ako budete koncový bod považovať za dostupný pre integráciu, potvrďte príslušnú službu a prostredie.
Z voliteľného rozsahu na overenú expozíciu
Skontrolujte dostupnosť a podmienky. Skontrolujte možnosť API v aktuálnej ponuke projektu. Pred aktiváciou sa rozhodnite, či táto funkcionalita je pre aplikáciu potrebná.
Vysvetlite operácie. Skontrolujte navrhované obchodné operácie a zodpovedajte na otázky týkajúce sa ich očakávaného správania. Postupujte podľa fáz prípravy a výstavby.
Pozrite si, čo je aktuálne. Skontrolujte katalóg trás a publikovanú dokumentáciu pre aktívny projekt. Naplánovaná trasa nie je funkčný koncový bod.
Pred pridávaním API definujte rozsah integrácie.
Vysvetlite, aké operácie potrebuje iný systém a preverte podmienky danej možnosti. API by malo slúžiť na dohodnutú obchodnú výmenu.
Otázky týkajúce sa API voliteľného projektu
Je to možnosť, ktorej dostupnosť a cena sa zobrazujú v aktuálnej ponuke. Aplikácia môže fungovať aj bez jej aktivácie. Táto prezentácia neposkytuje ani neaktivuje API pre váš projekt.
Popisuje zamýšľanú operáciu, ktorá ešte nie je registrovaná ako aktívny koncový bod. Pred začiatkom integrácie použite stav katalógu a aktuálnu publikovanú verziu.
Zobrazenia API projektu ukazujú oblasti, ktoré treba sprístupniť, otázky, infraštruktúru a stav výstavby. Vyriešte uvedené predpoklady a skontrolujte výsledný katalóg trás.
Použite referenčné materiály API, ktoré patria k aktivovanému projektu a príslušnému prostrediu. Nepoužívajte na vytvorenie koncového bodu alebo ukážky autentifikácie len plánovanú trasu.
Popisujú ďalšiu službu, ktorú vaša aplikácia využíva. Tento smer integrácie sa líši od sprístupňovania vlastných operácií aplikácie prostredníctvom API projektu.