Configuring Headers

To communicate with the Thredd API Hub, you must include the correct headers in each API request.

Request Headers

The following headers are mandatory and must be included in all requests made to the API Hub:

Name	Description	Example Value
Authorization	OAuth Credentials to authenticate your request.	Your OAuth Token
Content-Type	The media type of the requested resource.	`application/x-www-form-urlencoded`
X-Region	Note:* If you're not sure of the environment you should use, speak to your Account Manager or Implementations Manager. The region/environment you're trying to connect to. Select from: Use 0 for the Default environment Use 1 for the EMEA environment Use 2 for the APAC environment	0

Name

Description

Example Value

Authorization

OAuth Credentials to authenticate your request.

Your OAuth Token

Content-Type

The media type of the requested resource.

application/x-www-form-urlencoded

X-Region

*Note:** If you're not sure of the environment you should use, speak to your Account Manager or Implementations Manager.

The region/environment you're trying to connect to. Select from:

Use 0 for the Default environment
Use 1 for the EMEA environment
Use 2 for the APAC environment

Changing the X-Region HTTP Header in Postman

Thredd supply a Postman Collection that contains all endpoints available in the API Hub. By default, the HTTP header value for X-Region is set to 0 (Our default environment) for all endpoints. If you want to change the region to either 1 (for the EMEA environment) or 2 (for the APAC environment), navigate to the Variables tab of the Postman Collection and change the x-region value to the required environment.

Example of the x-region value in the Variables tab of the Postman Collection.

Pagination Headers

For some endpoints - such as the List card transaction(s) endpoint you can pass pagination values:

Name	Description	Value
`dateFrom`	The date from which you want your data to start from.	Format = YYYYMMDD e.g. 20200930
`dateTo`	The date from which you want your data to end on.	Format = YYYYMMDD e.g. 20210930

Updated 16 days ago