Neobavezni API projekta
Prikažite dogovorene operacije aplikacije kada su vam potrebne
Pregledajte opseg API-ja za prihvatljiv projekt i razlikujte planirane rute od već izrađenih krajnjih točaka.
Tretirajte API kao definiranu opciju projekta
- Pregledajte opciju
Provjerite dostupnost API-ja i odgovarajuću ponudu projekta.
- Definirajte opseg ruta
Pojasnite poslovne operacije koje bi API trebao izložiti.
- Pregledajte katalog ruta
Pregledajte metodu, putanju i planirani ili aktivni status svake rute.
Dodajte API kada ga vaš projekt treba
API projekta neobavezan je dio ponude. Pregledajte njegov opseg i uvjete prije aktivacije umjesto da pretpostavite da ga svaka aplikacija uključuje.
Alati za API organiziraju predložene rute po poslovnim oblastima. Pojašnjenja pomažu definirati što svaka operacija treba raditi prije implementacije.
Razlikujte predviđene rute od funkcionalnih krajnjih točaka
Pripremite pristup za drugi sustav. Projekt može trebati da druga aplikacija koristi njegove poslovne operacije. Pregledajte neobavezni opseg API-ja i ponudu umjesto da pretpostavite da je svaka funkcija automatski izložena. Dogovorene operacije određuju čemu integracija treba pristupati.
Pregledajte katalog ruta. Katalog prikazuje metodu, putanju, opis i stanje svake rute. Pomaže razlikovati predloženi opseg od krajnjih točaka registriranih kao aktivne. To je praktična referenca pri praćenju pripreme API-ja.
Odaberite ispravan smjer integracije. Korištenje API-ja drugog pružatelja i izlaganje vlastite aplikacije različite su potrebe. Vanjske veze pokrivaju prvo; API projekta pokriva dogovorenu izloženost. Odaberite put koji odgovara poslovnoj razmjeni koju želite.
Razlikujte izloženi API od vanjske veze
API projekta izlaže dogovorene operacije vaše aplikacije. Vanjska veza opisuje kako vaša aplikacija koristi drugu uslugu; služe različitim potrebama.
Upotrijebite katalog ruta za pregled metode, putanje i toga je li krajnja točka planirana ili aktivna. Ovaj prikaz ne aktivira API za vaš projekt.
Procijenite opciju API-ja prema konkretnoj potrebi
Utvrdite tko će koristiti podatke projekta i koje operacije ta integracija zahtijeva. To pomaže razlikovati neobavezni opseg API-ja od veze s postojećom vanjskom uslugom.
Za prihvatljiv projekt pregledajte planirane rute i njihovo stanje izrade. Potvrdite relevantnu uslugu i okruženje prije nego što krajnju točku smatrate dostupnom za integraciju.
Od neobaveznog opsega do provjerene izloženosti
Pregledajte dostupnost i uvjete. Provjerite opciju API-ja u stvarnoj ponudi projekta. Prije aktivacije odlučite treba li aplikaciji ta izloženost.
Pojasnite operacije. Pregledajte predložene poslovne operacije i odgovorite na pitanja o njihovu očekivanom ponašanju. Pratite stanja pripreme i izrade.
Pogledajte što je objavljeno. Pregledajte katalog ruta i objavljenu referencu za aktivirani projekt. Planirana ruta nije funkcionalna krajnja točka.
Definirajte opseg integracije prije dodavanja API-ja
Objasnite operacije koje drugi sustav treba i pregledajte uvjete opcije. API treba služiti dogovorenoj poslovnoj razmjeni.
Pitanja o neobaveznom API-ju projekta
To je opcija čija se dostupnost i cijena prikazuju u stvarnoj ponudi. Aplikacija može raditi i bez njezine aktivacije. Ovaj prikaz ne priprema niti omogućuje API za vaš projekt.
Opisuje predviđenu operaciju koja još nije registrirana kao aktivna krajnja točka. Prije početka integracije koristite stanje kataloga i stvarnu objavljenu referencu.
Prikazi API-ja projekta pokazuju oblasti za izlaganje, pitanja, infrastrukturu i stanja izrade. Riješite navedene preduvjete i pregledajte nastali katalog ruta.
Upotrijebite API referencu aktiviranog projekta i odgovarajućeg okruženja. Ne izvodite krajnju točku ni primjer autentifikacije samo iz planirane rute.
Opisuju drugu uslugu koju vaša aplikacija koristi. Taj smjer integracije razlikuje se od izlaganja operacija vaše vlastite aplikacije putem API-ja projekta.