Postman Collection

The Postman collection is a work in progress. It contains all requests, but some may lack descriptions or pre-set parameters.

This documentation is available as a Postman collection.

Use the link below to open collection source:

Open Collection JSON

Setup collection in Postman

  1. If you don’t have a workspace, create one.

    Create Workspace in Postman

  2. In your workspace, click the import button:

    Import Collection in Postman

    • Link

    • Raw

    • Local file

    Select the Link tab. Enter a link to the collection:

    api.saymon.tech/assets/SAYMON%20REST%20API.postman_collection.json

    Click the Continue button.

    postman import link

    Copy the collection source. Select the Raw text tab. Paste the copied file into the text field:

    postman import raw

    Click the Continue button.

    Select the File tab. Click the Choose Files button.

    Import collection as file

    Select the .json file with the collection.

    Choose file

  3. Click the Import button.

    Import button

  4. After importing the collection, click on the collection folder to set the necessary variables:

    Set folder variables

Authentication

This collection uses the Token Authentication. You should specify your token in the api-token variable.

You can generate this token either with SAYMON UI or with the Create Authentication Token request in the imported collection itself.

To generate the token in Postman follow these steps:

  • Setup saymonHostname, username, and password variables.

  • Open the SAYMON REST API/Authentication/Authentication Token/Create Authentication Token and click the Send button to send the Create Authentication Token request.

  • Set the api-token collection variable to the authentication token, returned in the response. Don’t include the quotation marks.