Working with API keys
An API key lets your business software connect to your Autobooks account. Create one key for each system you connect, such as your job management or ordering software. Keeping them separate lets you change or turn off one connection without affecting the others.
Only the primary administrator can create and manage API keys. If a developer is setting up the connection for you, create the key here, then securely share the client ID and key with them. Don't send keys by regular email or text.
View your API keys
Go to Developer > API Keys. You'll see a list of your keys, each with its name, permissions, and the date it was created. Select a key to open its details.
If you haven't created a key yet, you'll see API for developers and agents with a Create an API key button.
Create an API key
- Go to Developer > API Keys and select Create an API key.
- Name the key. Use the name of the system that will use it, such as "Job management." A name is required.
- Add a description (optional). Use it as a reminder of what the key is for.
- Review the permissions. Every key gets the same permissions, so you don't need to select anything.
- Select Create API key.
What every API key can do
| Permission | What it allows |
|---|---|
| Get invoices | View, search, and filter invoices |
| Manage invoices | Create invoices and update their details |
| Send invoices | Email invoices to customers |
| Get customers | View and filter customers |
| Manage customers | Add customers and update their details |
| Get products | View and filter products and services |
| Manage products | Add products and services and update their details |
Save your key details
When your key is ready, a confirmation window opens with your key's name (for example, Job management is ready). It shows:
- Client ID: Identifies your key. It isn't secret, but your developer will need it.
- Primary API key and Secondary API key: These are secret, so store them somewhere secure. Each one has a copy button.
- Open Getting started: Opens step-by-step instructions for making a first connection.
Select Done to close the window.
Note: You can find your keys again later. They're saved on the key's details page.
Manage a key
Select a key from the list to open its details page. From there you can:
- Change the key's name or description, then select Save changes.
- Copy the Client ID.
- View or copy the Primary key and Secondary key. Keys are hidden by default. Select the eye icon to show a key or the copy icon to copy it.
- See when each key was created and Rotate (replace) either key.
- See the key's permissions.
- Delete the key.
Why are there two keys? Both keys work at the same time. That way you can replace one key while your software keeps running on the other, so the connection isn't interrupted.
Replace (rotate) a key
Replace a key if you think it's been shared with someone who shouldn't have it, or as part of regular security practice.
- Switch your software to the other key first. Ask your developer to confirm your software is using the key you're not replacing.
- On the key you want to replace, select Rotate.
- In the confirmation window, select Rotate key. The new key replaces the old one right away.
Important: The old key stops working immediately. Anything still using it will stop connecting until it's updated with the new key.
Delete a key
Delete a key when you no longer use the connected system.
- Open the key and select Delete this API key.
- In the confirmation window, select Delete api key. To keep the key, select No.
Important: Deleting a key immediately turns off its client ID and both keys. Any software using them stops working. This can't be undone. To reconnect, you'd need to create a new key and update your software.