Authentication

Authentication to the API occurs via HTTP Basic Auth. Provide your API key as the basic auth username. You do not need to provide a password.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. You must authenticate all requests.

Sending Body Data

You will need to send body data with requests whenever you need to add or update structured data. For example, if you're sending a request to add a new customer to a database, you might include the customer details in JSON. Typically you will use body data with POST request.

The Body tab in 'Postman' allows you to specify the data you need to send with a request. You can send various different types of body data to suit your API.

Authentication Request (RAW DATA)

You can use raw body data to send anything you can enter as text. Use the raw tab, and the type dropdown list to indicate the format of your data (JSON) and 'Postman' will enable syntax-highlighting as well as appending the relevant headers to your request.

Some APIs require auth details you can send in 'Postman'. Authentication involves verifying the identity of the client sending a request, and authorization involves verifying that the client has permission to carry out the endpoint operation. Open the Authorization tab to configure your access details.

Choose the Authorization 'type' to 'Basic Auth' and key in the username & password. For more detail on implementing different types of auth in your 'Postman' requests, check out Authorizing requests.

Once your auth and other request details are set up, select Send to run your request.