Externe API-verzoeken

Met External API Requests kunt u request templates definiëren en vervolgens vanuit bedrijfsprocessen uitgaande aanroepen naar een willekeurige API starten. Hiermee kunt u uw project verbinden met elke dienst van derden, zelfs als er nog geen module voor bestaat op de markt.

Definitie

Raadpleeg de specificaties van hoe het verzoek moet worden gestructureerd in de API-documentatie van de dienstverlener waarmee u verbinding wilt maken.

1. Om een nieuw verzoektemplate te definiëren, ga naar het tabblad "Business Logic" op de zijbalk (1), schakel naar het tabblad "External API Requests" (2), en klik op "New API Request" (3).

2. Geef het nieuwe verzoek een naam en, optioneel, een beschrijving.

3. Selecteer de HTTP-methode van het verzoek en de URL ervan.

4. Definieer URL parameters, query parameters (alleen voor GET requests), headers en de body van het request door de parameter naam (1) en het type (2) in te voeren en te klikken op "Add Param" (3).

De werkelijke waarde van deze parameters wordt gedefinieerd op het moment van de uitvoering van het bedrijfsproces, waar het verzoek wordt geactiveerd.

Om het verschil te begrijpen tussen URL en query parameters, lees hier meer. Ongeacht de standaarden is de API-documentatie van de dienstverlener waarmee u verbinding wilt maken echter de beste bron van informatie over hoe het verzoek moet worden opgebouwd.

Je kunt de request headers en body ook automatisch invullen door voorbeeld JSON in te voeren, het systeem maakt dan automatisch alle benodigde parameters aan.

U hoeft niet op elk tabblad nieuwe parameters toe te voegen. Sommige verzoeken bevatten bijvoorbeeld helemaal geen URL-parameters, headers of body.

Als uw verzoek objecten bevat (bijv. auto -> kleur, grootte, enz.), moet u virtuele modellen maken om deze objecten later in uw bedrijfsprocessen te verwerken. Doe dat door "Model" te selecteren in de parameter type selector, en introduceer de kind-elementen die u nodig hebt. U kunt de objecten zo vaak nesten als u wilt (d.w.z. object binnen object) en virtuele modelarrays maken. Indien u de autofill functie heeft gebruikt, wordt dit proces automatisch uitgevoerd.

5. Wijzig de instellingen van het verzoek, zoals SSL-verificatie, time-out en foutafhandeling in het tabblad "Instellingen".

6. Test de aanvraag door op "Test Request" te klikken en alle vereiste parameters in te voeren. Controleer het antwoord van de server en vul de headers en de body van het antwoord automatisch of handmatig in.

7. Sla de aanvraagsjabloon op door te klikken op "Save Request".

Gebruik

Nadat u een nieuw verzoek hebt gedefinieerd en opgeslagen, komt een nieuw blok beschikbaar in de Editor Bedrijfsproces om het te activeren.

U zult het moeten voorzien van alle componenten die u aan het verzoek wilt toevoegen (URL en query parameters, headers en de body) als datamodellen, die u met deze blokken kunt maken. In de uitvoer kunt u de geformatteerde body van het antwoord, de headers en de status van het antwoord opnemen. U kunt deze modellen uitbreiden met behulp van deze blokken.

U hoeft niet alle gegevensingangen te verbinden om het verzoek correct te activeren. Als u bijvoorbeeld een verzoek hebt zonder URL-parameters, hoeft u het model daarvan niet aan te maken en te verbinden.

Voor elk virtueel model dat u hebt gedefinieerd, worden 2 nieuwe blokken toegevoegd aan uw Business Process Editor om het te maken en uit te breiden.

Bewaking

Telkens wanneer u een API-verzoek activeert, zal het systeem het type en adres, de request body, de response HTTP-statuscode en de response body naar de logs uitvoeren. U kunt andere informatie, zoals specifieke velden van de response body, of de latentie uitvoeren naar logs met behulp van het blok Write to Log.