Requirements

You donโ€™t need to be a developer to use this guide, but you will need to have a bit of experience using the command line and know how to create a text file. For sending requests to the server we use the โ€œcurlโ€ command, included with most operating systems. For easy visualisation of the response, we use the โ€œjqโ€ command, included with most operating systems. Install โ€œcurlโ€ and โ€œjqโ€, in case they are not installed in your system.

Create an Account

Head over to the Invopop Console and follow the steps to either log in or create an account.

Get a Token

  1. Once inside the console, click Settings.
  2. Enter the API Keys section.
  3. Tap the โ€œNew API Keyโ€ button.
  4. Provide a name for future reference, and any notes perhaps describing a use case, then click Save.
  5. Youโ€™ll be presented with a new token in text and a button to copy the details. Tap the copy button, and paste the token somewhere safe.
Invopop uses JSON Web Tokens. If youโ€™re interested in seeing the contents, head over to JWT.io and paste youโ€™re token to see whatโ€™s inside.

Test

To test our new token, open the Terminal and prepare our environment using the following command, replacing <TOKEN> with the actual token generated from the Invopop console in the last step:
export INVOPOP_TOKEN="<TOKEN>"
This saves us from copying and pasting the token every time we need to use it, and we can now make a call to the Invopop Ping service:
curl -H "Authorization: Bearer $INVOPOP_TOKEN" https://api.invopop.com/utils/v1/ping | jq .
Response:
{
  "ping": "pong"
}
This ping call doesnโ€™t do anything useful, other than ensuring that your connection and credentials are valid.
Most examples throughout this documentation will assume you have set the $INVOPOP_TOKEN variable.

Conclusion

Youโ€™ve now managed to authenticate with the Invopop API using a generated token.