API opțional pentru proiect
Afișează operațiunile aplicației convenite atunci când ai nevoie de ele
Revizuiește domeniul de aplicare al API-ului pentru un proiect eligibil și distinge rutele planificate de punctele finale deja construite.
Considerați API-ul ca pe o opțiune definită a proiectului
- Analizați opțiunea
Verifică disponibilitatea API-ului și oferta corespunzătoare a proiectului.
- Definiți domeniul de acoperire al rutei
Clarificați operațiunile comerciale pe care API-ul ar trebui să le expună.
- Verificați catalogul de rute
Consultați metoda, traseul și starea planificată sau în timp real a fiecărei rute.
Adaugă un API atunci când proiectul tău are nevoie de unul
API-ul proiectului este o parte opțională a ofertei. Analizați domeniul și condițiile acestuia înainte de activare, în loc să presupuneți că fiecare aplicație îl include.
Instrumentele API organizează rutele propuse pe domenii de activitate. Clarificările ajută la definirea a ceea ce ar trebui să facă fiecare operațiune înainte de implementarea acesteia.
Face distincția între rutele dorite și punctele finale funcționale
Pregătiți accesul pentru un alt sistem. Un proiect poate avea nevoie de o altă aplicație pentru a-și utiliza operațiunile comerciale. Analizați domeniul API opțional și ofertele, în loc să presupuneți că toate funcțiile sunt expuse automat. Operațiunile convenite definesc la ce ar trebui să aibă acces integrarea.
Verificați catalogul de rute. Catalogul prezintă metoda, traseul, descrierea și starea fiecărei rute. Acesta ajută la distingerea domeniului propus de punctele finale înregistrate ca fiind active. Acesta este o referință practică atunci când se urmează pregătirea API-ului.
Alegeți direcția corectă de integrare. Utilizarea API-ului unui alt furnizor și expunerea propriei aplicații reprezintă nevoi diferite. Conexiunile externe acoperă prima situație; API-ul proiectului acoperă expunerea convenită. Alegeți metoda care se potrivește cel mai bine cu tipul de schimb comercial pe care îl doriți.
Distingeți o interfață API expusă de o conexiune externă.
O API de proiect expune operațiunile convenite ale aplicației tale. O conexiune externă descrie modul în care aplicația ta utilizează un alt serviciu; acestea au scopuri diferite.
Utilizați catalogul de rute pentru a verifica metoda, calea și dacă un endpoint este planificat sau activ. Această prezentare nu activează o API pentru proiectul dvs.
Evaluați opțiunea API în raport cu o nevoie concretă
Identificați cine va consuma datele proiectului și ce operațiuni necesită acea integrare. Acest lucru ajută la distingerea unui perimetru API opțional de o conexiune la un serviciu extern existent.
Pentru un proiect eligibil, examinați rutele planificate și stadiul construirii lor. Confirmați serviciul și mediul relevante înainte de a considera un endpoint disponibil pentru o integrare.
De la o arie opțională la o vizibilitate verificată
Verificați disponibilitatea și condițiile. Verificați opțiunea API din oferta actuală a proiectului. Decideți dacă aplicația are nevoie de această funcționalitate înainte de activare.
Precizați operațiunile. Analizați operațiunile de afaceri propuse și răspundeți la întrebări despre comportamentul lor așteptat. Urmăriți stadiile de pregătire și construcție.
Consultă ce este disponibil în direct. Verificați catalogul de rute și referința publicată pentru un proiect activ. O rută planificată nu este un punct final funcțional.
Definiți domeniul de integrare înainte de a adăuga un API
Explicați operațiunile de care are nevoie un alt sistem și analizați condițiile opțiunii. API-ul ar trebui să deservească un schimb de afaceri convenit.
Întrebări despre API-ul proiectului opțional
Este o opțiune a cărei disponibilitate și preț apar în oferta efectivă. O aplicație poate funcționa fără a o activa. Această prezentare nu configurează sau nu activează un API pentru proiectul dumneavoastră.
Descrie o operațiune intenționată care nu este încă înregistrată ca punct final activ. Utilizați starea catalogului și referința publicată efectivă înainte de a începe integrarea.
Vizualizările API ale proiectului prezintă zonele care trebuie expuse, întrebările, infrastructura și stadiile de construcție. Rezolvați cerințele specificate și analizați catalogul de rute rezultat.
Utilizați referința API corespunzătoare proiectului și mediului activ. Nu derivați un endpoint sau un exemplu de autentificare doar dintr-o rută planificată.
Ele descriu un alt servici pe care aplicația ta îl utilizează. Această direcție de integrare este diferită de expunerea propriilor operațiuni ale aplicației tale prin intermediul API-ului proiectului.