Opcionális projekt-API
A szükséges alkalmazás-műveleteket akkor jelenítse meg, amikor szüksége van rájuk
Tekintse át egy jogosult projekt API-hatókörét, és különböztesse meg a tervezett útvonalakat a már elkészült végpontoktól.
Kezelje az API-t a projekt meghatározott opciójaként
- Tekintse át az opciót
Ellenőrizze az API elérhetőségét és a megfelelő projektajánlatot.
- Határozza meg az útvonalak hatókörét
Pontosítsa, milyen üzleti műveleteket tegyen elérhetővé az API.
- Vizsgálja meg az útvonalkatalógust
Tekintse meg az egyes útvonalak metódusát, elérési útját és tervezett vagy élő állapotát.
Adjon hozzá API-t, ha a projektjének szüksége van rá
A projekt-API az ajánlat opcionális része. Aktiválás előtt tekintse át a hatókörét és a feltételeit, ahelyett hogy feltételezné, hogy minden alkalmazás tartalmazza.
Az API-eszközök üzleti területek szerint rendezik a javasolt útvonalakat. A pontosítások segítenek meghatározni, mit kell tennie az egyes műveleteknek a megvalósítás előtt.
Különböztesse meg a tervezett útvonalakat a működő végpontoktól
Készítsen elő hozzáférést egy másik rendszer számára. Előfordulhat, hogy egy projektnél egy másik alkalmazásnak kell használnia az üzleti műveleteit. Tekintse át az opcionális API-hatókört és az ajánlatot, ahelyett hogy feltételezné, hogy minden funkció automatikusan elérhető. A megállapodott műveletek határozzák meg, mihez férhet hozzá az integráció.
Vizsgálja meg az útvonalkatalógust. A katalógus megjeleníti az egyes útvonalak metódusát, elérési útját, leírását és állapotát. Segít megkülönböztetni a javasolt hatókört az élőként regisztrált végpontoktól. Gyakorlati referencia az API előkészítésének követéséhez.
Válassza ki a megfelelő integrációs irányt. Egy másik szolgáltató API-jának használata és a saját alkalmazás elérhetővé tétele eltérő igény. Az előbbit a külső kapcsolatok fedik le, a megállapodott elérhetőséget pedig a projekt-API. Válassza az Ön által kívánt üzleti adatcserének megfelelő utat.
Különböztesse meg a közzétett API-t a külső kapcsolattól
A projekt-API az alkalmazása megállapodott műveleteit teszi elérhetővé. Egy külső kapcsolat azt írja le, hogyan használ az alkalmazása egy másik szolgáltatást; ezek eltérő igényeket szolgálnak.
Az útvonalkatalógusban megvizsgálhatja a metódust, az elérési utat, és azt, hogy egy végpont tervezett vagy élő. Ez a bemutatás nem aktivál API-t a projektjéhez.
Mérje fel az API-opciót egy konkrét igény alapján
Határozza meg, ki fogja használni a projekt adatait, és milyen műveletekre van szüksége az integrációnak. Ez segít megkülönböztetni az opcionális API-hatókört egy meglévő külső szolgáltatással való kapcsolattól.
Jogosult projekt esetén vizsgálja meg a tervezett útvonalakat és építési állapotukat. Mielőtt egy végpontot integráció számára elérhetőnek tekintene, erősítse meg a megfelelő szolgáltatást és környezetet.
Az opcionális hatókörtől az ellenőrzött elérhetőségig
Tekintse át az elérhetőséget és a feltételeket. Ellenőrizze az API-opciót a tényleges projektajánlatban. Aktiválás előtt döntse el, hogy az alkalmazásnak szüksége van-e erre az elérhetőségre.
Pontosítsa a műveleteket. Tekintse át a javasolt üzleti műveleteket, és válaszoljon a várt működésükre vonatkozó kérdésekre. Kövesse az előkészítés és az építés állapotát.
Tekintse meg, mi érhető el élesben. Vizsgálja meg egy aktivált projekt útvonalkatalógusát és közzétett referenciáját. Egy tervezett útvonal nem működő végpont.
Határozza meg az integráció hatókörét, mielőtt API-t ad hozzá
Írja le, milyen műveletekre van szüksége a másik rendszernek, és tekintse át az opció feltételeit. Az API-nak egy megállapodott üzleti adatcserét kell szolgálnia.
Kérdések az opcionális projekt-API-ról
Ez egy olyan opció, amelynek elérhetősége és ára a tényleges ajánlatban jelenik meg. Az alkalmazás ennek aktiválása nélkül is működhet. Ez a bemutatás nem hoz létre és nem engedélyez API-t a projektjéhez.
Egy olyan tervezett műveletet ír le, amely még nincs élő végpontként regisztrálva. Az integráció megkezdése előtt használja a katalógus állapotát és a ténylegesen közzétett referenciát.
A projekt-API nézetei a közzéteendő területeket, a kérdéseket, az infrastruktúrát és az építés állapotát mutatják. Teljesítse a megadott előfeltételeket, és vizsgálja meg az így létrejött útvonalkatalógust.
Használja az aktivált projekthez és a megfelelő környezethez tartozó API-referenciát. Ne pusztán egy tervezett útvonalból vezessen le végpontot vagy hitelesítési példát.
Egy másik szolgáltatást írnak le, amelyet az alkalmazása használ. Ez az integrációs irány eltér attól, amikor saját alkalmazásműveleteit a projekt-API-n keresztül teszi elérhetővé.