Valgfrit projekt-API
Vis de aftalte applikationshandlinger, når du har brug for dem
Gennemgå et API-omfang for et kvalificeret projekt, og skeln mellem planlagte ruter og de endpoints, der allerede er bygget.
Behandl API'et som en defineret projektmulighed
- Gennemgå muligheden
Kontrollér API'ets tilgængelighed og det tilsvarende projekttilbud.
- Fastlæg rutenes omfang
Afklar, hvilke forretningsoperationer API'et skal udstille.
- Gennemgå rutekataloget
Se metode, sti og den planlagte eller aktive status for hver rute.
Tilføj et API, når dit projekt har brug for et
Projekt-API'et er en valgfri del af tilbuddet. Gennemgå dets omfang og vilkår før aktiveringen i stedet for at antage, at alle applikationer indeholder det.
API-værktøjerne organiserer de foreslåede ruter efter forretningsområde. Afklaringer hjælper med at definere, hvad hver operation skal gøre, før den implementeres.
Skeln mellem tilsigtede ruter og fungerende endpoints
Forbered adgang for et andet system. Et projekt kan have brug for, at en anden applikation bruger dets forretningsoperationer. Gennemgå det valgfrie API-omfang og tilbuddet i stedet for at antage, at alle funktioner udstilles automatisk. De aftalte operationer afgør, hvad integrationen skal have adgang til.
Gennemgå rutekataloget. Kataloget viser hver rutes metode, sti, beskrivelse og status. Det hjælper med at skelne det foreslåede omfang fra endpoints, der er registreret som aktive. Det er en praktisk reference, når du følger forberedelsen af API'et.
Vælg den rigtige integrationsretning. At bruge en anden udbyders API og at udstille din egen applikation er forskellige behov. Eksterne forbindelser dækker det første; projekt-API'et dækker den aftalte udstilling. Vælg den vej, der passer til den forretningsmæssige udveksling, du ønsker.
Skeln mellem et udstillet API og en ekstern forbindelse
Et projekt-API udstiller din applikations aftalte operationer. En ekstern forbindelse beskriver, hvordan din applikation bruger en anden tjeneste; de dækker forskellige behov.
Brug rutekataloget til at se metode, sti og om et endpoint er planlagt eller aktivt. Denne præsentation aktiverer ikke et API for dit projekt.
Vurdér API-muligheden ud fra et konkret behov
Find ud af, hvem der skal bruge projektets data, og hvilke operationer integrationen kræver. Det hjælper med at skelne et valgfrit API-omfang fra en forbindelse til en eksisterende ekstern tjeneste.
For et kvalificeret projekt skal du gennemgå de planlagte ruter og deres opbygningsstatus. Bekræft den relevante tjeneste og det relevante miljø, før du betragter et endpoint som tilgængeligt for en integration.
Fra et valgfrit omfang til en verificeret udstilling
Gennemgå tilgængelighed og vilkår. Kontrollér API-muligheden i projektets faktiske tilbud. Beslut før aktiveringen, om applikationen har brug for den udstilling.
Afklar operationerne. Gennemgå de foreslåede forretningsoperationer, og besvar spørgsmål om deres forventede adfærd. Følg forberedelses- og opbygningsstatussen.
Se, hvad der er live. Gennemgå rutekataloget og den publicerede reference for et aktiveret projekt. En planlagt rute er ikke et fungerende endpoint.
Fastlæg integrationens omfang, før du tilføjer et API
Forklar, hvilke operationer et andet system har brug for, og gennemgå mulighedens vilkår. API'et skal tjene en aftalt forretningsmæssig udveksling.
Spørgsmål om det valgfrie projekt-API
Det er en mulighed, hvis tilgængelighed og pris fremgår af det faktiske tilbud. En applikation kan fungere uden at aktivere den. Denne præsentation klargør eller aktiverer ikke et API for dit projekt.
Den beskriver en tilsigtet operation, der endnu ikke er registreret som et aktivt endpoint. Brug status i kataloget og den faktisk publicerede reference, før du starter en integration.
Visningerne af projekt-API'et viser de områder, der skal udstilles, spørgsmål, infrastruktur og opbygningsstatusser. Opfyld de angivne forudsætninger, og gennemgå det resulterende rutekatalog.
Brug den API-reference, der hører til det aktiverede projekt og det relevante miljø. Udled ikke et endpoint eller et godkendelseseksempel ud fra en planlagt rute alene.
De beskriver en anden tjeneste, som din applikation bruger. Den integrationsretning er noget andet end at udstille din egen applikations operationer via projekt-API'et.