Skip to main content

How to create an API key

Letting another system read your LoadSnap records, and how to shut it off again.

An API key lets another system read your LoadSnap records. Your accountant's software, a reporting tool, or whoever built your website. They can read your loads and the waste on them, your jobs, customers, vehicles and the documents filed against a load, without anybody logging in and downloading spreadsheets.

Two things to be clear about before you start. It is reading only: nothing holding a key can create, change or delete anything in your account, and it cannot submit anything to DEFRA. And it is on the Business plan and above.

How to do it

  1. Click Settings, then Integrations, then API keys.

  2. In the Name box, type what the key is for, for example "Sage export box". Name it after the thing that will use it, so you know what you are turning off later.

  3. Click Create key.

  4. Copy the key straight away, using the Copy button beside it. It is shown once and never again.

  5. Click "I have saved it" once it is somewhere safe, then give it to whoever is connecting the other system.

Turning one off

  1. Find the key in the list and click Revoke.

  2. Confirm. Anything using it stops working immediately, and it cannot be undone.

  3. If you meant to swap it rather than kill it, create the new key first.

Worth knowing

  • API keys are on the Business plan and above. Below that you can still see and revoke the keys you already hold, and any key you keep starts working again the moment the plan does.

  • You can have ten active keys. Revoke the ones you are not using rather than collecting them.

  • A key belongs to your organisation rather than to one person, so it keeps working after whoever created it has left. That is a reason to revoke a key the day the system using it is retired.

  • The list shows when each key was created and when it was last used, which is the quickest way to spot one nobody needs any more.

  • If a key gets out, revoke it and create a new one. Treat one like a password, because that is what it is.

Related: Exporting to Sage, Xero & QuickBooks.

Did this answer your question?