Hoe gebruik je Postman

Postman is een API voor het bouwen en gebruiken van API's. Het koppelen van je Document360-project aan Postman is eenvoudig en kan in enkele minuten worden afgerond. Je kunt de postbode op locatie of online gebruiken.

OPMERKING

Voor meer informatie over de toepassing van Postman, lees de volgende artikelen.

• Hoe download je de Postman-applicatie?

• Hoe installeer en update je de Postman-applicatie?

• Hoe gebruik je Postman?

• Veelgestelde vragen in Postman

Je Document360-project koppelen in Postman

1. De onderstaande stappen zijn gebaseerd op de Postman-applicatie voor de lokale postman.

2. Open de Postbode-aanvraag.

3. Klik in de sectie Mijn Werkruimte op de knop Importeren .

   Er verschijnt een pop-up venster Importeren .

4. Voer de onderstaande URL in het veld in.
   https://apihub.document360.io/swagger/v2/swagger.json
   De pop-up Kies hoe je je API importeert verschijnt met twee opties.

5. Selecteer de gewenste optie

   • Postbode Verzameling (standaard)

   • OpenAPI 3.0 met een Postman Collection

6. Klik op de knop Importeren .

   Zodra de import is voltooid, maakt de actie een voorbeeldverzoek aan voor elk eindpunt, zodat je het verzoek snel kunt doen.
   

   

Authenticatie in Postman - Het genereren van een API-token

1. Vouw in de boomweergave de Document360 Customer API uit.

2. Zet onder het tabblad Autorisatie het Auth Type op API-sleutel in het dropdownmenu.

3. Voer de gewenste variabele in het Key-veld in.

4. Voer het API-token in in het Value-veld. Lees voor het genereren van een API-token het artikel over Genereren van token.

   OPMERKING

   Een API-token genereren

   1. Navigeer naar () in de linker navigatiebalk in het Kennisbankportaal.

   2. Ga in het linker navigatiepaneel naar Knowledge base portal > API Tokens.

   3. Maak het gewenste API-token aan en kopieer het token.

   (of) Kopieer de token van een bestaande token.

1. Ga in de linker navigatiebalk naar Omgevingen.

2. Klik in het linker navigatiepaneel op Omgevingen aanmaken.

3. Typ onder de kolom Variabelen een variabelenaam , bijvoorbeeld 'base_URL,' en zet het Type op standaard.

4. Voer https://apihub.document360.io de velden INITIAL VALUE en CURRENT VALUE in voor de basis-URL.

5. Klik op de knop Opslaan .

   De projectauthenticatie is voltooid. Nu kun je eenvoudig alle beschikbare eindpunten bereiken en verschillende acties uitvoeren.

   

Gebruikssituaties

Met de hulp van Postman kun je verschillende acties uitvoeren in Document360.

Hier zijn een paar basisgebruiksscenario's ter referentie

• Hoe maak en publiceer je een artikel?

• Hoe werk je een gepubliceerd artikel bij?

• Hoe werk je SEO-gegevens bij?

FAQ