Volitelné API projektu
Zobrazte dohodnuté aplikační operace, když je potřebujete
Posuďte rozsah API pro způsobilý projekt a odlište plánované trasy od již vytvořených endpointů.
Berte API jako definovanou možnost projektu
- Zkontrolujte možnost
Zkontrolujte dostupnost API a odpovídající nabídku projektu.
- Vymezte rozsah tras
Ujasněte, které obchodní operace má API zpřístupnit.
- Prohlédněte si katalog tras
Prohlédněte si metodu, cestu a plánovaný nebo živý stav každé trasy.
Přidejte API, když ho váš projekt potřebuje
API projektu je volitelnou součástí nabídky. Před aktivací zkontrolujte jeho rozsah a podmínky, místo abyste předpokládali, že ho obsahuje každá aplikace.
Nástroje API uspořádávají navržené trasy podle obchodních oblastí. Upřesnění pomáhají definovat, co má každá operace dělat, ještě před její implementací.
Odlište zamýšlené trasy od funkčních endpointů
Připravte přístup pro jiný systém. Projekt může potřebovat, aby jiná aplikace využívala jeho obchodní operace. Zkontrolujte volitelný rozsah API a nabídku, místo abyste předpokládali, že každá funkce je zpřístupněna automaticky. Dohodnuté operace určují, k čemu má integrace přistupovat.
Prohlédněte si katalog tras. Katalog zobrazuje u každé trasy metodu, cestu, popis a stav. Pomáhá odlišit navržený rozsah od endpointů zaregistrovaných jako živé. Je to praktická reference při sledování přípravy API.
Zvolte správný směr integrace. Používání API jiného poskytovatele a zpřístupnění vlastní aplikace jsou různé potřeby. To první pokrývají externí připojení, dohodnuté zpřístupnění pokrývá API projektu. Zvolte cestu, která odpovídá požadované obchodní výměně.
Odlište zpřístupněné API od externího připojení
API projektu zpřístupňuje dohodnuté operace vaší aplikace. Externí připojení popisuje, jak vaše aplikace používá jinou službu; slouží různým potřebám.
Pomocí katalogu tras zkontrolujte metodu, cestu a to, zda je endpoint plánovaný, nebo v provozu. Tato prezentace pro váš projekt API neaktivuje.
Posuďte možnost API vůči konkrétní potřebě
Určete, kdo bude data projektu využívat a jaké operace tato integrace vyžaduje. Pomůže to odlišit volitelný rozsah API od připojení k existující externí službě.
U způsobilého projektu si prohlédněte plánované trasy a stav jejich tvorby. Než endpoint považujete za dostupný pro integraci, ověřte příslušnou službu a prostředí.
Od volitelného rozsahu k ověřenému zpřístupnění
Zkontrolujte dostupnost a podmínky. Zkontrolujte možnost API ve skutečné nabídce projektu. Před aktivací rozhodněte, zda aplikace takové zpřístupnění potřebuje.
Ujasněte operace. Zkontrolujte navržené obchodní operace a odpovězte na otázky k jejich očekávanému chování. Sledujte stav přípravy a tvorby.
Zjistěte, co je v provozu. Prohlédněte si katalog tras a publikovanou referenci aktivovaného projektu. Plánovaná trasa není funkční endpoint.
Před přidáním API vymezte rozsah integrace
Vysvětlete operace, které jiný systém potřebuje, a zkontrolujte podmínky této možnosti. API by mělo sloužit dohodnuté obchodní výměně.
Otázky k volitelnému API projektu
Jde o možnost, jejíž dostupnost a cena jsou uvedeny ve skutečné nabídce. Aplikace může fungovat i bez její aktivace. Tato prezentace pro váš projekt API nezřizuje ani nezapíná.
Popisuje zamýšlenou operaci, která ještě není zaregistrována jako živý endpoint. Před zahájením integrace vycházejte ze stavu v katalogu a skutečně publikované reference.
Přehledy API projektu zobrazují oblasti ke zpřístupnění, otázky, infrastrukturu a stavy tvorby. Splňte uvedené předpoklady a prohlédněte si výsledný katalog tras.
Použijte referenční dokumentaci API, která patří k aktivovanému projektu a příslušnému prostředí. Neodvozujte endpoint ani příklad ověření pouze z plánované trasy.
Popisují jinou službu, kterou vaše aplikace používá. Tento směr integrace se liší od zpřístupnění operací vaší vlastní aplikace prostřednictvím API projektu.