Optionele project-API
Toon de overeengekomen applicatiebewerkingen wanneer je ze nodig hebt
Beoordeel de API-scope voor een geschikt project en onderscheid geplande routes van de endpoints die al zijn gebouwd.
Behandel de API als een gedefinieerde projectoptie
- Bekijk de optie
Controleer de beschikbaarheid van de API en het bijbehorende projectaanbod.
- Bepaal de scope van de routes
Verduidelijk welke bedrijfsbewerkingen de API moet ontsluiten.
- Bekijk de routecatalogus
Raadpleeg de methode, het pad en de geplande of live status van elke route.
Voeg een API toe wanneer uw project er een nodig heeft
De project-API is een optioneel onderdeel van het aanbod. Bekijk de scope en voorwaarden vóór activering, in plaats van aan te nemen dat elke applicatie deze bevat.
De API-tools ordenen de voorgestelde routes per bedrijfsgebied. Verduidelijkingen helpen te bepalen wat elke bewerking moet doen voordat ze wordt geïmplementeerd.
Onderscheid beoogde routes van werkende endpoints
Bereid toegang voor een ander systeem voor. Soms moet een andere applicatie de bedrijfsbewerkingen van een project kunnen gebruiken. Beoordeel de optionele API-scope en het aanbod in plaats van aan te nemen dat elke functie automatisch wordt ontsloten. De afgesproken bewerkingen bepalen waartoe de integratie toegang moet hebben.
Bekijk de routecatalogus. De catalogus toont van elke route de methode, het pad, de beschrijving en de status. Zo onderscheidt u de voorgestelde scope van endpoints die als live zijn geregistreerd. Dit is een praktische referentie bij het volgen van de voorbereiding van de API.
Kies de juiste integratierichting. De API van een andere provider gebruiken en uw eigen applicatie ontsluiten zijn verschillende behoeften. Externe verbindingen dekken het eerste; de project-API dekt de afgesproken ontsluiting. Kies de weg die past bij de zakelijke uitwisseling die u wilt.
Onderscheid een ontsloten API van een externe verbinding
Een project-API ontsluit de afgesproken bewerkingen van uw applicatie. Een externe verbinding beschrijft hoe uw applicatie een andere service gebruikt; ze dienen verschillende behoeften.
Gebruik de routecatalogus om de methode, het pad en de status van een endpoint (gepland of live) te bekijken. Deze presentatie activeert geen API voor uw project.
Toets de API-optie aan een concrete behoefte
Bepaal wie de gegevens van het project zal gebruiken en welke bewerkingen die integratie nodig heeft. Zo onderscheidt u een optionele API-scope van een verbinding met een bestaande externe service.
Bekijk voor een geschikt project de geplande routes en hun bouwstatus. Bevestig de betreffende service en omgeving voordat u een endpoint als beschikbaar voor een integratie beschouwt.
Van een optionele scope naar een geverifieerde ontsluiting
Beoordeel beschikbaarheid en voorwaarden. Controleer de API-optie in het werkelijke projectaanbod. Bepaal vóór activering of de applicatie die ontsluiting nodig heeft.
Verduidelijk de bewerkingen. Bekijk de voorgestelde bedrijfsbewerkingen en beantwoord vragen over het verwachte gedrag ervan. Volg de voorbereidings- en bouwstatus.
Bekijk wat live staat. Bekijk de routecatalogus en de gepubliceerde referentie van een geactiveerd project. Een geplande route is geen werkend endpoint.
Bepaal de integratiescope voordat u een API toevoegt
Leg uit welke bewerkingen een ander systeem nodig heeft en bekijk de voorwaarden van de optie. De API moet een afgesproken zakelijke uitwisseling dienen.
Vragen over de optionele project-API
Het is een optie waarvan de beschikbaarheid en prijs in het werkelijke aanbod staan. Een applicatie kan werken zonder deze te activeren. Deze presentatie richt geen API in voor uw project en schakelt er ook geen in.
Het beschrijft een beoogde bewerking die nog niet als live endpoint is geregistreerd. Gebruik de status in de catalogus en de werkelijk gepubliceerde referentie voordat u een integratie start.
De weergaven van de project-API tonen de te ontsluiten gebieden, vragen, infrastructuur en bouwstatussen. Los de vermelde vereisten op en bekijk de resulterende routecatalogus.
Gebruik de API-referentie van het geactiveerde project en de betreffende omgeving. Leid een endpoint of een authenticatievoorbeeld niet af uit alleen een geplande route.
Ze beschrijven een andere service die uw applicatie gebruikt. Die integratierichting staat los van het ontsluiten van de eigen bewerkingen van uw applicatie via de project-API.