New to VisionScaper?
Start here
Help Center › API keys & connections › Creating access keys and choosing scopes
Creating access keys and choosing scopes
Make a named access key, choose its scopes, copy it once, and turn it off when it is no longer needed.
An access key is a long secret that lets other software act for your business. A scope limits what the key can do.
Steps to make a key
- Open Settings → Zapier & API keys, tab Access keys.
- Under Make a key, fill What will use it? For example, “Zapier” or “Reporting sheet”. The name can be up to 80 characters.
- Under What may it do?, tick at least one scope.
- Press Make a key.
- A box titled Copy your new key now appears. Press Copy key.
- Store the key in a password manager.
- Press I have saved it.
The full key is shown only once. VisionScaper stores a one-way hash and keeps just the first 12 characters so you can recognise it. If you lose it, turn it off and make another.
The scopes
| Tick box on screen | Scope name | Lets the key |
|---|---|---|
| Look at customers and leads | read_customers |
List and fetch customers |
| Add and change customers | write_customers |
Create and update customers |
| Look at quotes | read_quotes |
List and fetch quotes |
| Look at invoices | read_invoices |
List and fetch invoices |
| Look at jobs | read_jobs |
List and fetch jobs |
| Add new leads | write_leads |
Post leads |
| Look at payments | read_payments |
List payments |
| Set up alerts (needed by Zapier) | webhooks_manage |
Make, list and delete alerts |
Key format
A key looks like vsk_ plus 8 characters, an underscore, then 40 more (all lowercase letters and digits). Anything that does not match is refused as invalid.
Turning a key off
- In Your keys, find the key. It shows the first characters, its scopes, when it was last used, and how many times.
- Press Turn off, and confirm. A turned-off key stops working at once. The list keeps it, marked “Turned off”.
Tips
- Give each key the fewest scopes it needs.
- A key that can only read cannot change anything.
- Rotate keys when people leave.
- Every creation and shutdown is written to the activity notes.
- Limit: 20 active keys per business.
If something goes wrong
- “Give the key a name so you remember what uses it.” Fill the name box.
- “Choose at least one thing this key may do.” Tick a scope.
- “You have 20 active keys.” Turn one off first.
- Calls answer 403 “insufficient_scope”: see API errors and rate limits.