Een Postman Collection voor een aangepaste connector maken

Postman is een app voor het maken van HTTP-aanvragen en Postman-verzamelingen helpen u bij het organiseren en groeperen van gerelateerde API-aanvragen. Met verzamelingen kunt u sneller en eenvoudiger aangepaste connectors ontwikkelen als u nog geen OpenAPI-definitie voor uw API hebt. Zie Verzamelingen maken in de Postman-documentatie voor meer informatie over verzamelingen.

In dit onderwerp maakt u een verzameling met een aanvraag en respons van de Cognitive Services Text Analytics API. In een gerelateerd onderwerp maakt u een connector met behulp van deze verzameling.

Vereisten

• De Postman-app
• Een API-sleutel voor de Cognitive Services Text Analytics-API

Een HTTP-aanvraag maken voor de API

1. Selecteer in Postman op het tabblad Builder de HTTP-methode, voer de aanvraag-URL voor het API-eindpunt in en selecteer eventueel een autorisatieprotocol.

   

   Parameter	Weergegeven als
   HTTP-methode	"POST"
   Aanvraag-URL	"https://westus.api.cognitive.microsoft.com/text/analytics/v2.0/sentiment"
   Autorisatie	"Geen autorisatie" (in de volgende stap geeft u een API-sleutel op)

2. Voer sleutel-waardeparen voor de aanvraagheader in. Voor veelvoorkomende HTTP-headers kunt u selecteren in de vervolgkeuzelijst.

   

   Toets	Weergegeven als
   Ocp-Apim-Subscription-Key	uw-API-abonnementssleutel. Deze vindt u in uw Cognitive Services-account
   Inhoud-Type	"application/json"

3. Voer inhoud in die u wilt verzenden in de aanvraagtekst. Kies Verzenden om te controleren of de aanvraag werkt en u een respons ontvangt.

   

   {
       "documents": [{
           "language": "en-us",
           "id": "1", 
           "text": "I enjoyed the new movie after a long day."
       }]
   }
   

   Het responsveld bevat de volledige respons van de API, inclusief het resultaat of een fout, indien er een fout is opgetreden.

   

Zie Aanvragen in de Postman-documentatie voor meer informatie over HTTP-aanvragen.

De verzameling opslaan

1. Kies Opslaan.

   

2. Geef bij Aanvraag opslaan een aanvraagnaam en een beschrijving voor de aanvraag op. De aangepaste connector gebruikt deze waarden voor het bewerkingsoverzicht en de beschrijving van de API.

   

   Parameter	Weergegeven als
   Aanvraagnaam	"DetectSentiment"
   Beschrijving van aanvraag	"De API retourneert een numerieke score tussen 0 en 1." Scores dicht bij 1 duiden op een positief gevoel en scores dicht bij 0 op een negatief gevoel."

3. Kies + Verzameling maken en geef een naam op voor de verzameling. De aangepaste connector gebruikt deze waarde als u de API aanroept. Kies het selectievakje (hiermee maakt u een verzamelingsmap) en kies vervolgens Opslaan in SentimentDemo.

   

   Parameter	Weergegeven als
   Verzamelingsnaam	"Gevoelsdemo"

Sla de respons voor de aanvraag op

Nu u de aanvraag hebt opgeslagen, kunt u de respons opslaan. Op deze manier wordt de respons weergegeven als voorbeeld wanneer u de aanvraag later laadt.

1. Kies boven het responsvenster de optie Respons opslaan.

   

   Aangepaste connectors ondersteunen slechts één respons per aanvraag. Als u meerdere responsen per aanvraag opslaat, wordt alleen de eerste gebruikt.

2. Geef boven aan de app een naam op voor de voorbeeldrespons en kies Voorbeeld opslaan.

   

Als de API extra functies heeft, kunt u nu doorgaan met het uitbreiden van de Postman-verzameling met eventuele aanvullende aanvragen en responsen.

De Postman-verzameling exporteren

U kunt de verzameling nu als een JSON-bestand exporteren, dat u importeert met de wizard voor aangepaste connectors. Voordat u de verzameling exporteert, verwijdert u eerst het inhoudstype en de beveiligingsheaders. Deze waren vereist om API-aanvragen te maken, maar worden in de aangepaste connector anders verwerkt.

1. Wijs bij Headers elke header aan en kies de X naast de header om deze te verwijderen. Kies Opslaan om de verzameling opnieuw op te slaan.

   

2. Kies het beletselteken (. . . .) naast de verzameling en kies vervolgens Exporteren.

   

3. Kies de exportindeling Verzameling v1, kies Exporteren en blader vervolgens naar de locatie waar u het JSON-bestand wilt opslaan.

   

   Notitie

   Momenteel kunt u alleen v1-collecties gebruiken voor aangepaste connectors.

Volgende stappen

U bent nu klaar om een aangepaste connector te definiëren op basis van de Postman-verzameling die u hebt gemaakt:

• Een aangepaste connector maken op basis van een Postman-verzameling