Skip to main content

​
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, and for easy visualization of the response, the “jq” command — both 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, open Configuration → API keys and click Manage API keys. This takes you to the API keys section of Admin, where keys are created.
  2. Click New API key.
  3. Choose the workspace the key will act on. Pick your sandbox workspace while you’re testing.
  4. Provide a name for future reference, and optionally a description of the use case.
  5. Tick the permissions the key needs. For this guide, Read on All services is enough; for a real integration, grant only the services it uses. See API keys for what each permission covers.
  6. Click Create API key. You’ll be presented with the new token and a button to copy it. The token is shown only once, so paste it somewhere safe.
Invopop uses JSON Web Tokens. If you’re interested in seeing the contents, head over to JWT.io and paste your 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:
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:
Response:
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.

Have your agent wire the token into this project and verify it.

Open in Cursor

​
Conclusion

You’ve now managed to authenticate with the Invopop API using a generated token.

Participate in our community

Ask and answer questions about authentication →