Using Zeal credentials

Include the API key in the Authentication as a bearer token. Other parameters can be added, as specified in the API endpoints.

Example Authorization Header

Authorization: Bearer <YOUR API KEY>

Code Examples

JavaScript

const request = require('request');

request({
  url: '<zeal-endpoint>',
  headers: {
     'Authorization': 'Bearer <API KEY>'
  },
}, function(err, res) {
      if(err) {
        console.error(err);
      } else {
        console.log(res.body);
      }
});

cURL

curl <zeal-endpoint>
   -H "Accept: application/json"
   -H "Authorization: Bearer <API KEY>"

Python

import requests

url = "<zeal-endpoint>"

headers = {}
headers["Accept"] = "application/json"
headers["Authorization"] = "Bearer " + <API KEY>

resp = requests.get(url, headers=headers)

Test and Production API Keys

You can find Test and Production API Keys on your Zeal dashboard on the API page.

API calls to the below endpoints using the Test key will result in responses reflecting Test data or changes to the Test data (test employees, test employer checks, test employee checks).

API calls to the below endpoints using the Production key will result in responses reflecting Live data or changes to the Live data — payrolls will be run and money will be disbursed.