Authentication & security
You'll need to authenticate your requests to access any of the endpoints in the HUB API. In this guide, we'll look at how authentication works. The HUB uses an API key as an Authentication: bearer for every request made.
API key
All the HUB api's use the API key as an authentication header. Here's how to authenticate using cURL:
Example request with basic auth
curl https://api.payocityhub.com/v2/paymentjobs \
-H "Authorization: Bearer {api_key}"
Make sure to perform requests using HTTPS, as unencrypted HTTP requests are not supported.
X-Signature Header
The X-Signature header is a crucial component of our REST API authentication and security system. Every non error response will be accompanied by a signature, as a response header or in the URL. This signature can be used to verify the integrity of the response from the HUB.
Using an SDK
If you use one of our official SDKs, you won't have to worry about the signature calculation and verification — fetch your API key from the HUB dashboard , and the client library will take care of the rest.