Valfritt projekt-API
Visa de överenskomna applikationsfunktionerna när du behöver dem
Granska API-omfattningen för ett kvalificerat projekt och skilj planerade routes från de endpoints som redan har byggts.
Behandla API:et som ett definierat projektalternativ
- Granska alternativet
Kontrollera API:ets tillgänglighet och motsvarande projekterbjudande.
- Definiera omfattningen för routes
Förtydliga vilka verksamhetsoperationer API:et ska exponera.
- Granska route-katalogen
Se metod, sökväg och planerad eller aktiv status för varje route.
Lägg till ett API när ditt projekt behöver ett
Projekt-API:et är en valfri del av erbjudandet. Granska dess omfattning och villkor före aktivering i stället för att anta att varje applikation omfattar det.
API-verktygen ordnar de föreslagna routes per verksamhetsområde. Förtydliganden hjälper till att definiera vad varje operation ska göra innan den implementeras.
Skilj avsedda routes från fungerande endpoints
Förbered åtkomst för ett annat system. Ett projekt kan behöva låta en annan applikation använda dess verksamhetsoperationer. Granska det valfria API:ets omfattning och erbjudande i stället för att anta att varje funktion exponeras automatiskt. De överenskomna operationerna avgör vad integrationen ska få åtkomst till.
Granska route-katalogen. Katalogen visar metod, sökväg, beskrivning och status för varje route. Den hjälper till att skilja den föreslagna omfattningen från endpoints som registrerats som aktiva. Det är en praktisk referens när du följer förberedelsen av API:et.
Välj rätt integrationsriktning. Att använda en annan leverantörs API och att exponera din egen applikation är olika behov. Externa anslutningar täcker det första; projekt-API:et täcker överenskommen exponering. Välj den väg som passar det affärsutbyte du vill ha.
Skilj ett exponerat API från en extern anslutning
Ett projekt-API exponerar applikationens överenskomna operationer. En extern anslutning beskriver hur din applikation använder en annan tjänst; de tillgodoser olika behov.
Använd route-katalogen för att granska metod, sökväg och om en endpoint är planerad eller aktiv. Den här presentationen aktiverar inte något API för ditt projekt.
Bedöm API-alternativet mot ett konkret behov
Identifiera vem som ska använda projektets data och vilka operationer integrationen kräver. Det hjälper till att skilja en valfri API-omfattning från en anslutning till en befintlig extern tjänst.
För ett kvalificerat projekt granskar du de planerade routes och deras byggstatus. Bekräfta den relevanta tjänsten och miljön innan du betraktar en endpoint som tillgänglig för en integration.
Från en valfri omfattning till en verifierad exponering
Granska tillgänglighet och villkor. Kontrollera API-alternativet i det faktiska projekterbjudandet. Avgör före aktiveringen om applikationen behöver den exponeringen.
Förtydliga operationerna. Granska de föreslagna verksamhetsoperationerna och besvara frågor om deras förväntade beteende. Följ förberedelse- och byggstatus.
Se vad som är live. Granska route-katalogen och den publicerade referensen för ett aktiverat projekt. En planerad route är inte en fungerande endpoint.
Definiera integrationens omfattning innan du lägger till ett API
Förklara vilka operationer ett annat system behöver och granska villkoren för alternativet. API:et ska tjäna ett överenskommet affärsutbyte.
Frågor om det valfria projekt-API:et
Det är ett alternativ vars tillgänglighet och pris framgår av det faktiska erbjudandet. En applikation kan fungera utan att aktivera det. Den här presentationen provisionerar eller aktiverar inte något API för ditt projekt.
Den beskriver en avsedd operation som ännu inte är registrerad som en aktiv endpoint. Använd katalogens status och den faktiskt publicerade referensen innan du påbörjar en integration.
Vyerna för projekt-API:et visar områdena som ska exponeras, frågorna, infrastrukturen och byggstatus. Lös de angivna förutsättningarna och granska den resulterande route-katalogen.
Använd den API-referens som hör till det aktiverade projektet och den relevanta miljön. Härled inte en endpoint eller ett autentiseringsexempel enbart från en planerad route.
De beskriver en annan tjänst som din applikation använder. Den integrationsriktningen skiljer sig från att exponera din egen applikations operationer via projekt-API:et.