Welkom bij het Aplaza API portaal

Via deze Developer portal kan je als aangesloten partij APIs verkennen en testen.

Sign up Explore APIs

Account aanmaken

Maak eerst een account aan. Dit kan door middel van de Sign up knop. Daarna zal je een mail ontvangen, volg hierin de instructies op. Nadat je je account hebt geactiveerd, zal Aplaza je toegang gaan geven tot de juiste set van API’s.

APIs verkennen

Als je bent ingelogd, zul je op de "APIs" pagina een overzicht kunnen zien met de APIs waarop je toegang hebt. Als een API wordt geselecteerd, kom je in het API detail scherm terecht.

Hier kan je het dropdown menu "API definition" een format selecteren om de API definitie te downloaden. Verder kan je in het detail scherm links alle afzonderlijke operaties bekijken en de beschrijvingen en definities zien.

Er zal ook een groene "Try it" knop te zien zijn, als hier op wordt geklikt krijg je de mogelijkheid om de API te testen.

Onder het kopje "HTTP request" is een drop down menu om een codebase te selecteren. Hiermee wordt een generieke implementatie getoond in de geselecteerde code base op basis van de ingevulde data in het testscherm.

Subscriptions

Voor sommige APIs is er een subscription nodig om deze aan te kunnen roepen. Deze moeten worden aangevraagd, waarna je een subscription key toegestuurd zal krijgen. Deze moeten meegestuurd worden in de header "Ocp-Apim-Subscription-Key", of als query parameter "subscription-key=" om je te authenticeren.

Bij problemen, neem contact op met de beheerder.