Valgfritt prosjekt-API
Vis de avtalte applikasjonsoperasjonene når du trenger dem
Gå gjennom et API-omfang for et kvalifisert prosjekt, og skill planlagte ruter fra endepunktene som allerede er bygget.
Behandle API-et som et definert prosjektalternativ
- Gå gjennom alternativet
Kontroller API-ets tilgjengelighet og det tilsvarende prosjekttilbudet.
- Fastsett rutenes omfang
Avklar hvilke forretningsoperasjoner API-et skal eksponere.
- Se gjennom rutekatalogen
Se metode, bane og planlagt eller aktiv status for hver rute.
Legg til et API når prosjektet ditt trenger det
Prosjekt-API-et er en valgfri del av tilbudet. Gå gjennom omfanget og vilkårene før aktiveringen i stedet for å anta at alle applikasjoner inkluderer det.
API-verktøyene organiserer de foreslåtte rutene etter forretningsområde. Avklaringer hjelper med å definere hva hver operasjon skal gjøre før den implementeres.
Skill tiltenkte ruter fra fungerende endepunkter
Forbered tilgang for et annet system. Et prosjekt kan trenge at en annen applikasjon bruker forretningsoperasjonene dets. Gå gjennom det valgfrie API-omfanget og tilbudet i stedet for å anta at alle funksjoner eksponeres automatisk. De avtalte operasjonene bestemmer hva integrasjonen skal ha tilgang til.
Se gjennom rutekatalogen. Katalogen viser metode, bane, beskrivelse og status for hver rute. Den hjelper deg å skille foreslått omfang fra endepunkter som er registrert som aktive. Dette er en praktisk referanse når du følger forberedelsen av API-et.
Velg riktig integrasjonsretning. Å bruke en annen leverandørs API og å eksponere din egen applikasjon er ulike behov. Eksterne tilkoblinger dekker det første; prosjekt-API-et dekker den avtalte eksponeringen. Velg veien som passer til den forretningsmessige utvekslingen du ønsker.
Skill et eksponert API fra en ekstern tilkobling
Et prosjekt-API eksponerer de avtalte operasjonene i applikasjonen din. En ekstern tilkobling beskriver hvordan applikasjonen din bruker en annen tjeneste; de dekker ulike behov.
Bruk rutekatalogen til å se metode, bane og om et endepunkt er planlagt eller aktivt. Denne presentasjonen aktiverer ikke et API for prosjektet ditt.
Vurder API-alternativet opp mot et konkret behov
Finn ut hvem som skal bruke prosjektets data, og hvilke operasjoner integrasjonen krever. Det hjelper deg å skille et valgfritt API-omfang fra en tilkobling til en eksisterende ekstern tjeneste.
For et kvalifisert prosjekt går du gjennom de planlagte rutene og byggestatusen deres. Bekreft den aktuelle tjenesten og miljøet før du regner et endepunkt som tilgjengelig for en integrasjon.
Fra et valgfritt omfang til en verifisert eksponering
Gå gjennom tilgjengelighet og vilkår. Kontroller API-alternativet i prosjektets faktiske tilbud. Bestem før aktiveringen om applikasjonen trenger denne eksponeringen.
Avklar operasjonene. Gå gjennom de foreslåtte forretningsoperasjonene, og svar på spørsmål om forventet virkemåte. Følg forberedelses- og byggestatusen.
Se hva som er i drift. Se gjennom rutekatalogen og den publiserte referansen for et aktivert prosjekt. En planlagt rute er ikke et fungerende endepunkt.
Fastsett integrasjonens omfang før du legger til et API
Forklar hvilke operasjoner et annet system trenger, og gå gjennom vilkårene for alternativet. API-et skal tjene en avtalt forretningsmessig utveksling.
Spørsmål om det valgfrie prosjekt-API-et
Det er et alternativ der tilgjengelighet og pris fremgår av det faktiske tilbudet. En applikasjon kan fungere uten å aktivere det. Denne presentasjonen klargjør eller aktiverer ikke et API for prosjektet ditt.
Den beskriver en tiltenkt operasjon som ennå ikke er registrert som et aktivt endepunkt. Bruk statusen i katalogen og den faktisk publiserte referansen før du starter en integrasjon.
Visningene for prosjekt-API-et viser områdene som skal eksponeres, spørsmål, infrastruktur og byggestatuser. Oppfyll de angitte forutsetningene, og se gjennom den resulterende rutekatalogen.
Bruk API-referansen som hører til det aktiverte prosjektet og det aktuelle miljøet. Ikke utled et endepunkt eller et autentiseringseksempel fra en planlagt rute alene.
De beskriver en annen tjeneste som applikasjonen din bruker. Denne integrasjonsretningen er noe annet enn å eksponere operasjonene i din egen applikasjon via prosjekt-API-et.