Start here

Check an API key: whose key it is

One call that answers whose key this is: the name you gave it, its product and the member who created it. It costs nothing and never returns the key.

When to use it

  • Integrations show it to tell one connected account from another. Zapier, for example, labels each connection with the key’s name and its creator’s email.
  • Your own code can call it at start-up to check a key works before it captures anything.

It counts towards no allowance and makes no capture. It is subject to the same rate limits as the rest of the API.

The route

GEThttps://api.websitescreenshotworld.com/instant-snap/v1/account
  • With an Instant Snap key (wsw_api_): https://api.websitescreenshotworld.com/instant-snap/v1/account, shown above.
  • With an Auto Schedule key (wsw_autoapi_): https://autoapi.websitescreenshotworld.com/auto-schedule/v1/account.
curl https://api.websitescreenshotworld.com/instant-snap/v1/account \
  -H "X-Api-Key: $WSW_API_KEY"

The answer

200 OK
{
  "success": true,
  "key_name": "Zapier",
  "key_prefix": "0123456789ab",
  "product": "instant_snap",
  "email": "you@example.com"
}
FieldTypeDefaultDescription
key_namestring or null—The name you gave the key under Developer Tools, API Keys.
key_prefixstring—The key’s public prefix, as the app shows it beside the name. It is not enough to use the key.
productstring—instant_snap or auto_schedule: the API the key belongs to.
emailstring or null—The member who created the key; null when they are no longer a member.

The key itself is never returned

Nothing in the answer lets anyone use the key. Keep the key itself out of logs and labels.

Errors

Refusals use the same envelope as the rest of each API:

FieldTypeDefaultDescription
api_key_invalid401—The key is missing, wrong, revoked or expired, or belongs to the other API.
rate_limited429—Too many requests; wait for Retry-After.
service_unavailable503—The key could not be checked just now; try again after Retry-After.

Did this page answer your question?

Tell us what is missing