Neobvezna API projekta
Prikažite dogovorjene operacije aplikacije, ko jih potrebujete.
Preglejte obseg API za upravičen projekt in razlikujte načrtovane poti od končnih točk, ki so že zgrajene.
Obravnavajte API kot določeno možnost projekta
- Preglejte možnost
Preverite razpoložljivost API-ja in ustrezno ponudbo projekta.
- Določite obseg poti
Natančno opišite poslovne operacije, ki jih naj bi API podpiral.
- Oglejte si katalog poti
Oglejte si metodo, pot in načrtovani ali trenutni status vsake poti.
Dodajte API, kadar ga vaš projekt potrebuje
API projekta je neobvezni del ponudbe. Pred aktivacijo preverite njegov obseg in pogoje, namesto da predpostavljate, da ga vsebuje vsaka aplikacija.
Orodja API organizirajo predlagane poti po poslovnih področjih. Pojasnila pomagajo določiti, kaj bi morala vsaka operacija storiti pred njeno izvedbo.
Ločite predvidene poti od delujočih končnih točk
Pripravite dostop za drug sistem. Projekt morda potrebuje drugo aplikacijo za izvajanje svojih poslovnih operacij. Preglejte neobvezni obseg API-ja in ponudbo namesto da predpostavljate, da so vse funkcije samodejno na voljo. Dogovorjene operacije določajo, do česa bi morala imeti integracija dostop.
Preglejte katalog poti. Katalog prikazuje metodo, pot, opis in stanje vsake poti. Pomaga ločiti predlagani obseg od končnih točk, ki so registrirane kot aktivne. To je praktičen priročnik pri pripravi na uporabo API-ja.
Izberite pravilno smer integracije. Uporaba API-ja drugega ponudnika in razkritje vaše lastne aplikacije sta različna potreba. Zunanja povezava pokriva prvo; projektni API pokriva dogovorjeno razkritje. Izberite pot, ki ustreza poslovni izmenjavi, ki jo želite.
Ločite API, ki je izpostavljen, od zunanje povezave
API projekta ponuja dogovorjene funkcije vaše aplikacije. Zunanja povezava opisuje, kako vaša aplikacija uporablja drugo storitev; služita različnim namenom.
Uporabite katalog poti za pregled metode, poti in ali je končna točka načrtovana ali aktivna. Ta predstavitev ne aktivira API-ja za vaš projekt.
Možnost API ocenite glede na konkretno potrebo
Ugotovite, kdo bo uporabljal podatke projekta in katere operacije zahteva ta integracija. To pomaga ločiti izbirni obseg API od povezave z obstoječo zunanjo storitvijo.
Pri upravičenem projektu preglejte načrtovane poti in stanje njihove izdelave. Preden končno točko štejete za razpoložljivo za integracijo, potrdite ustrezno storitev in okolje.
Od neobveznega obsega do potrjene izpostavljenosti
Preglejte razpoložljivost in pogoje. Preverite možnost API v ponudbi za dejanski projekt. Odločite, ali aplikacija potrebuje to funkcionalnost pred aktivacijo.
Pojasnite postopke. Preglejte predlagane poslovne operacije in odgovorite na vprašanja o njihovem pričakovanem delovanju. Spremljajte faze priprave in izgradnje.
Oglejte si, kaj je objavljeno. Preglejte katalog poti in objavljeno referenčno dokumentacijo za aktivni projekt. Načrtovana pot ni delujoča končna točka.
Pred dodajanjem API-ja določite obseg integracije.
Pojasnite, katere operacije potrebuje drug sistem, in preverite pogoje možnosti. API bi moral služiti dogovorjenemu poslovnemu izmenjavi.
Vprašanja o API-ju neobveznega projekta
To je možnost, katere razpoložljivost in cena sta navedeni v ponudbi. Aplikacija lahko deluje tudi brez aktivacije te možnosti. Ta predstavitev ne omogoča ali ne vključi API-ja za vaš projekt.
Opisuje predvideno operacijo, ki še ni registrirana kot aktivna končna točka. Pred začetkom integracije uporabite stanje kataloga in dejansko objavljeno referenco.
Pogledi na API projekta prikazujejo območja, ki jih je treba razkriti, vprašanja, infrastrukturo in stanja gradnje. Odpravite navedene predpogoje in preglejte nastali katalog poti.
Uporabite API-referenco, ki pripada aktivnemu projektu in ustrezni okolici. Ne izpeljujte končne točke ali primera za preverjanje pristnosti samo iz načrtovane poti.
Opisujejo še eno storitev, ki jo uporablja vaša aplikacija. Ta smer integracije se razlikuje od izpostavljanja lastnih operacij aplikacije prek API-ja projekta.