Bouw en configureer een tool

Begin met de officiële API-documentatie voor de zakelijke service en een taak die uw account mag uitvoeren. Eén beperkt, goed beschreven hulpmiddel is gemakkelijker te testen dan een generiek hulpmiddel dat een willekeurige URL en methode accepteert.

Definieer het verzoek#

Geef de tool een stabiele naam en een beschrijving waarin het doel ervan, de belangrijke beperkingen en de vraag of gegevens worden gewijzigd, worden uitgelegd. Selecteer de gedocumenteerde HTTP-methode en het eindpunt. Gebruik tijdelijke aanduidingen alleen voor de variabele padelementen die de bewerking daadwerkelijk toestaat.

Bij het opzoeken van fictieve records kan het pad een record-ID bevatten. De hostnaam en accountregio moeten deel blijven uitmaken van de geconfigureerde verbinding in plaats van modelinvoer met een open einde.

Invoer definiëren en in kaart brengen#

Gebruik het invoerschema om elk veld, het type, de vereiste status en geldige waarden te beschrijven. Een klein schema voor een fictieve zoekopdracht is:

{
  "type": "object",
  "properties": {
    "record_id": {
      "type": "string",
      "description": "The verified identifier of the record to read"
    }
  },
  "required": ["record_id"],
  "additionalProperties": false
}

Wijs argumenten toe aan de gedocumenteerde pad-, query- of hoofdtekstvelden. Controleer of ontbrekende verplichte velden en onverwachte extra argumenten duidelijk falen. Bewaar authenticatie in de ondersteunde serververbinding, niet in een prompt, voorbeeldschema of hardgecodeerde toolheader.

Vorm de uitvoer#

Het in kaart brengen of transformeren van antwoorden kan de velden retourneren die de workflow nodig heeft in plaats van een volledig serviceantwoord. Controleer de getransformeerde uitvoer ten opzichte van het oorspronkelijke testresultaat. Verwijder niet de record-ID, pagineringinformatie of foutdetails die nodig zijn om te begrijpen of het resultaat compleet is.

Controleer de bedrijfsinstellingen#

De toolconfiguratie ondersteunt instellingen voor time-out, caching en opnieuw proberen. Gebruik caching alleen als verouderde gegevens acceptabel zijn; een in de cache opgeslagen leesbewerking is niet geschikt als definitief bewijs dat een schrijfbewerking zojuist is voltooid. Als u een niet-idempotente schrijfbewerking opnieuw probeert, kunnen er duplicaten ontstaan. Kies daarom het gedrag voor opnieuw proberen uit de gedocumenteerde garanties van de API.

Test het echte pad#

Controleer correcte invoer, ongeldige invoer, lege resultaten, toestemmingsfout en een begrensde succesvolle oproep. Testdiagnostiek kan gevoelige verzoekinformatie bevatten; inspecteer ze alleen via de goedgekeurde beheerdersroute en bewerk ze voordat u ze deelt. Zie testen voordat een klant de tool gebruikt.