Connect to the API

After receiving the API key you’ll need to generate your Authorization header for your API requests. You’ll need to use this Authorization header on every request that you will submit to the Whispir API

Whispir uses Basic HTTP Authentication for all API requests

You can generate the Authorization header in most programming languages very easily. However, for convenience you can generate it here by filling in the form below.

Note: The credentials entered on this page are not submitted or stored, but only processed as part of an algorithm to automatically generate your header

Authorization Header:


IMPORTANT: since your Header is built from your credentials please ensure to recalculate it any time you change your password

Once you’ve generated this header you can use it in a request to the API. This will ensure everything is working correctly. To do this you can use a programming language, a curl script or a generic REST client

To test your connectivity you will now need the following parameters:

  • The URL that you would like to request
  • Your API key
  • Your Authorization header
  • (optional) The Content-Type/Accept Headers

To do this you can use a programming language, a curl script or a generic REST client

Using cURL

cURL is a computer software project providing a library and command-line tool for transferring data using various protocols. One key use of cURL is to make HTTP requests

In order to test your ability to use the WhispirAPI, cURL is a very quick mechanism to enter into a command line interface and make sure everything is set up correctly

  • JSON
  • XML

Connect to the API using cURL

{{codeStart}}

curl --location --request GET 'https://api.<region>.whispir.com' --header 'x-api-key: YOUR-API-KEY' --header 'Authorization: YOUR-AUTH-HEADER' --header 'Accept: application/vnd.whispir.company-v1+json'

{{codeEnd}}

# with sample values

{{codeStart}}

curl --location --request GET 'https://api.au.whispir.com' --header 'x-api-key: 89aUAtBusdfohhZI6zoFNasd89023rsdf3X3h44c' --header 'Authorization: Basic am9obi5zbWl0aDpteXBhc3N3b3Jk' --header 'Accept: application/vnd.whispir.company-v1+json'

{{codeEnd}}

Sample Response

{{codeStart}}

{

"id": "AD7671EB2DB89638",

"link": [

{

"uri": "https://api.au.whispir.com/workspaces",

"rel": "retrieveWorkspaces",

"method": "GET",

"host": "api.au.whispir.com",

"port": -1

},

...

]

}

{{codeEnd}}

Using a generic REST client

An alternate way to test Whispir API is to install Postman or any other API Client. In the rest of the documentation the APIs will be listed to ease this second option

  • JSON
  • XML

Connect to the API using an API Client

{{codeStart}}

GET https://api.<region>.whispir.com

 

Authorization: Basic am9obi5zbWl0aDpteXBhc3N3b3Jk

x-api-key: your_api_key

Accept: application/vnd.whispir.company-v1+json

{{codeEnd}}

Once you have executed this request, you should receive a 200 OK response from the REST client and the same response payloads seen before with cURL. This means that you have connectivity to the Whispir API and can start building your app

If you received a different response, continue to the next section to understand how to resolve your issues

Resolving connectivity issues

HTTP 403 Forbidden or HTTP 401 Unauthorized

  • You may be using an invalid API key
  • You may be using an invalid Authorization header, especially if you recently changed the password. If so, please use the tool above to build the new value to be passed
  • If you can't log in it’s possible that your account isn’t active. Contact your Whispir Company Administrator

Other HTTP errors or no connectivity at all

If you’re still having issues contact the Whispir Support Team