Skip to Content

Create an API key

Make a key for one of your systems in Settings, choose what it may do, and revoke it when you no longer need it.

A key lets one of your own systems, such as your PIM or your shop, use the API for your company. You make and revoke keys yourself on the platform. Make one key per system, so you can replace one without stopping the others.

Open Settings, then Developer

Sign in at platform.charpstar.co and open Settings. The Developer tab lists your company's keys. Anyone at your company can make and revoke them.

If the tab says the API is not switched on for your company, ask your CharpstAR contact to switch it on.

Press New key and fill in the form

AA name you will recognise laterBWhat the key may see and changeCWhen it expires, and from where it worksDMake the key, then copy it
  • Name. Name the key after the system that will use it, for example "PIM sync". The name is how you tell keys apart later.
  • See and Change. Tick what the key may do. A new key starts with the See boxes ticked. Ticking Change for an area also ticks See for it. What each scope allows lists which call needs which box.
  • Expires. In 30 days, in 90 days, in 1 year, or never. One year is the default.
  • Only from these addresses. Leave it empty and the key works from anywhere. To tie it to your servers, enter IP ranges such as 203.0.113.0/24, up to 20 of them.

Copy the key

Press Make key. The key is shown once, so copy it then. We store only a fingerprint of it and cannot show it again.

Keep it as a secret on your server, for example as CHARPSTAR_API_KEY. Never put it in a web page or an app.

Check that it works

curl -sS https://platform.charpstar.co/api/v1/me \
  -H "Authorization: Bearer $CHARPSTAR_API_KEY"

The answer names your company, the first characters of the key and its scopes.

GET/api/v1/meany valid key

Revoke a key

Each key in the list shows its first characters, what it may do, when it was last used and when it expires. Press Revoke on a key to stop it. Systems using it stop working at once, and their calls get 401 unauthorized.

If a key is lost or may have leaked, make a new one, move your system to it, then revoke the old one.

On this page