Glossary
What is API key?
An API key is a secret string that identifies your account when your software calls an API, so the service knows who is sending and who to bill.
Treat an API key like a password. Keep it on your server, out of browser code and out of your Git history, and give each system its own key so you can revoke one without breaking the others. Most APIs, CaptiFi Connect's included, take the key in an Authorization header as a Bearer token.
A dental group in Leicester might give its booking system one key and its patient recall tool another, so if one leaks it only has to replace that one.
CaptiFi Connect has live keys, which start cc_live_, and test keys, which start cc_test_. A key is shown once when you create it and we keep only a hash, so if you lose it you create a new one and revoke the old. Every key belongs to one account and can only see that account's data.