Aan de slag met STEF-APIs
Volg deze handleiding om uw account te activeren, uw applicatie aan te maken, APIs te abonneren en ze veilig aan te roepen.
1. Aanmelden op het API-portaal
Met het STEF API-portaal kunt u zich abonneren op STEF-API's via persoonlijke consumerapplicaties of applicaties die binnen een team worden gedeeld.
- Om toegang te krijgen tot het portaal, moet u de aanmaak van een klantaccount aanvragen.
- Neem hiervoor contact op met uw STEF IT-contactpersoon zodat deze de nodige stappen kan ondernemen.
- U ontvangt een uitnodiging waarmee u uw account kunt aanmaken en zich kunt aanmelden op de STEF-portalen voor kwalificatie en productie.
Het wachtwoord moet elke 200 dagen worden vernieuwd; u krijgt tijdens het aanmelden op het portaal een melding wanneer deze update nodig is.
Toegang tot de API-portalen
- Productie: https://api-portal-ext.stef.com/
- Kwalificatie: https://api-portal-quaext.stef.com/
Om een consumerapplicatie te kunnen aanmaken die met uw team wordt gedeeld, moet u uw STEF IT-contactpersoon vragen om een team te laten aanmaken.
2. Een applicatie aanmaken
Om een API te kunnen gebruiken, moet u eerst beschikken over een consumerapplicatie. Bij het aanmaken wordt een credential gegenereerd, de identificatie van uw applicatie tijdens een aanroep.
- Klik rechtsboven in het portaal op uw profiel
- Klik op de knop Applications
- Klik op de knop New application
- Vul de naam en beschrijving van uw applicatie in
- Om deze applicatie met uw team te delen, vinkt u This is a team owned application aan en selecteert u het gewenste team
- Klik op de knop Create application
- Noteer de credential die tijdens het aanmaken is gegenereerd
3. Zich abonneren op een API
Een consumerapplicatie kan zich, afhankelijk van de behoefte, op een of meerdere API's abonneren.
Gebruik het menu APIs om de catalogus van beschikbare STEF-API's te raadplegen.
Navigeer naar de producten die u interesseren om de technische ontwikkelaarsdocumentatie te openen, die voor elke API het volgende bevat:
- De verschillende ondersteunde bewerkingen
- De definitie van invoer- en uitvoerobjecten
- Codevoorbeelden om ze te gebruiken
Om u op een API te abonneren:
- Open de detailweergave van een API
- Klik rechtsboven op Use this API
- Klik op de knop Register die hoort bij de applicatie waarop u zich wilt abonneren
Het abonnement moet daarna door STEF worden gevalideerd; neem hiervoor contact op met uw STEF IT-contactpersoon.
Aangezien een applicatie zich op meerdere API's kan abonneren, herhaalt u de abonnementsprocedure voor elke API die u wilt gebruiken.
Uw abonnementen raadplegen en beheren
Om de abonnementen van een applicatie te bekijken, klikt u linksboven op uw profiel en vervolgens op Applications, en daarna op de naam van uw applicatie. Op het tabblad APIs, dat automatisch wordt weergegeven, vindt u de lijst met uw abonnementen en hun status.
U kunt vanuit dit menu ook een abonnement op andere API's aanvragen door op + API te klikken.
4. Een API gebruiken
Alle aanroepen van STEF-API's verlopen via de STEF API Gateway om toegangsbeveiligingsregels toe te passen, de backendservices van het STEF-informatiesysteem te beschermen en aanroepstatistieken te verzamelen.
De API Gateway is toegankelijk via de volgende URL's:
- Productie: https://api-suitelogi-ext.stef.com
- Kwalificatie: https://api-suitelogi-quaext.stef.com
Om een API te gebruiken en de toegangsbeveiligingsregels na te leven, voegt u de HTTP-header X-STEF-Client-Id toe aan het verzoek, ingevuld met de credential van uw consumerapplicatie.
De technische ontwikkelaarsdocumentatie biedt voor elke API die op het platform is gepubliceerd codevoorbeelden waarmee u de API Gateway vanuit verschillende talen kunt aanroepen: Shell, Python, Node.js, JavaScript, Go, Java, C# en Ruby.
Voorbeeldaanroep
curl -X GET "https://api.stef.com/v1/transport/orders" \
-H "X-STEF-Client-Id: <YOUR_APPLICATION_SECRET>" \
-H "Content-Type: application/json"
Naast de codevoorbeelden biedt de technische ontwikkelaarsdocumentatie formulieren waarmee u API's rechtstreeks vanuit het portaal in interactieve modus kunt aanroepen via de knop Try it!.