API opsionale e projektit
Paraqitni operacionet e aplikacionit të cilat janë rënë dakord kur ju nevojiten.
Rishikoni fushën e një API për një projekt të përshtatshëm dhe dalloni rrugët e planifikuara nga pikat përfundimtare që janë ndërtuar tashmë.
Trajtojeni API-n si një opsion të përcaktuar projekti
- Rishikoni opsionin
Kontrolloni disponueshmërinë e API-së dhe ofertën e projektit përkatës.
- Definoni fushën e rrugës
Përcaktoni operacionet e biznesit që API-ja duhet t'i ekspozojë.
- Kontrolloni katalogun e rrugëve
Konsultoni metodën, rrugën dhe statusin e planuar ose aktual të secilës rrugë.
Shto një API kur projekti juaj ka nevojë për të.
API-ja e projektit është një pjesë opsionale e ofertës. Rishikoni fushën dhe kushtet e saj para aktivimit, në vend që të supozoni se çdo aplikacion e përfshin atë.
Mjetet API organizojnë rrugët e propozuara sipas zonës së biznesit. Përshkrimet ndihmojnë në përcaktimin e asaj që secila operacion duhet të bëjë para implementimit të tij.
Dalloni rrugët e synuara nga pikat përfundimtare funksionale
Përgatitni aksesin për një sistem tjetër. Një projekt mund të ketë nevojë për një aplikacion tjetër për të përdorur operacionet e tij biznesore. Rishikoni fushën opcionale të API-së dhe ofertën, në vend që të supojoni se çdo funksion është ekspozuar automatikisht. Operacionet e dakordësuara përcaktojnë se çfarë duhet të ketë akses integrimi.
Kontrolloni katalogun e rrugëve. Katalogu tregon metodën, rrugën, përshkrimin dhe gjendjen e secilës rrugë. Ai ndihmon në dallimin e fushës së propozuar nga pikat përfundimtare të regjistruara si të gjalla. Ky është një referencë praktike kur ndiqni përgatitjen e API-së.
Zgjidhni drejtimin e duhur të integrimit. Përdorimi i API-së së një furnitori tjetër dhe ekspozimi i aplikacionit tuaj janë nevoja të ndryshme. Lidhjet e jashtme i përfshijnë të parat; API-ja e projektit i përfshin ekspozimet e miratuara. Zgjidhni rrugën që përshtatet me shkëmbimin e biznesit që dëshironi.
Dalloni një API të ekspozuar nga një lidhje e jashtme
Një API projekti ekspozon operacionet e dakordura të aplikacionit tuaj. Një lidhje e jashtme përshkruan se si aplikacioni juaj përdor një shërbim tjetër; ato shërbejnë nevoja të ndryshme.
Përdorni katalogun e rrugëve për të inspektuar metodën, rrugën dhe nëse një endpoint është i planifikuar ose aktiv. Kjo prezantim nuk aktivizon një API për projektin tuaj.
Vlerësoni opsionin API përkundrejt një nevoje konkrete
Identifikoni kush do t'i përdorë të dhënat e projektit dhe cilat veprime kërkon ai integrim. Kjo ndihmon të dallohet një fushëveprim opsional API nga një lidhje me një shërbim të jashtëm ekzistues.
Për një projekt të përshtatshëm, shqyrtoni rrugët e planifikuara dhe gjendjen e ndërtimit të tyre. Konfirmoni shërbimin dhe mjedisin përkatës para se ta konsideroni një pikë fundore të disponueshme për një integrim.
Nga një fushë e mundshme në ekspozim të verifikuar
Kontrolloni disponueshmërinë dhe kushtet. Kontrolloni opsionin API në ofertën aktuale të projektit. Vendosni nëse aplikacioni ka nevojë për këtë funksionalitet përpara aktivimit.
Sqaroni operacionet. Rishikoni operacionet e propozuara të biznesit dhe përgjigjeni pyetjeve rreth sjelljes së tyre të pritur. Ndiqni fazat e përgatitjes dhe ndërtimit.
Shikoni çfarë është aktive. Kontrolloni katalogun e rrugëve dhe referencën e publikuar për një projekt të aktivizuar. Një rrugë e planifikuar nuk është një pikë fundore funksionale.
Definoni fushën e integrimit përpara se të shtoni një API
Shpjegoni operacionet që nevojiten nga një sistem tjetër dhe rishikoni kushtet e opsionit. API-ja duhet të shërbejë një shkëmbim biznesi të miratuar.
Pyetje rreth API-së së projektit opsional
Është një opsion, për të cilin disponueshmëria dhe çmimi shfaqen në ofertën aktuale. Një aplikacion mund të funksionojë pa e aktivizuar atë. Ky paraqitje nuk siguron apo mundëson një API për projektin tuaj.
Ai përshkruan një operacion të synuar që ende nuk është regjistruar si një pikë lidhjeje aktive. Përdorni gjendjen e katalogut dhe referencën e publikuar aktuale para se të filloni integrimin.
Pamjet e API-së së projektit tregojnë zonat për t'u ekspozuar, pyetjet, infrastrukturën dhe gjendjet e ndërtimit. Zgjidhni parakushtet e deklaruara dhe inspektoni katalogun e rrugëve të krijuara.
Përdorni referencën e API-së që i përket projektit të aktivuar dhe mjedisit përkatës. Mos derivoni një fundpunkt ose një shembull autentikimi vetëm nga një rrugë e planifikuar.
Ata përshkruajnë një shërbim tjetër që aplikacioni juaj përdor. Ai drejtim i integrimit është i ndryshëm nga ekspozimi i operacioneve të aplikacionit tuaj përmes API-së së projektit.