Projects and API keys
The console is where you manage your projects. Everything you do through the API is scoped to one project: its numbers, its connected mailboxes and its usage.
A project’s page
Section titled “A project’s page”Open Projects and pick a project. The page shows:
- Name and id. The id is the project’s identifier. It is not an API key and is never accepted as one.
- Enabled. A switch that turns the project on or off.
- Active numbers and connected mailboxes, as counts.
- API key. The key your clients send in the
X-API-Keyheader. It is masked until you reveal or copy it. - Account assignments. Which provider account the project uses for each provider it needs.
- Allowed return origins. Which origins a mailbox connection may return to.
API key
Section titled “API key”Copy the key from the project page and keep it on your server. See Authentication for how to send it.
Rotating it
Section titled “Rotating it”Rotate issues a new key and invalidates the old one. The console confirms before it does, and shows the new key once it is created. The change reaches every service within about 30 seconds, so update the clients that use the key promptly.
Provider account assignments
Section titled “Provider account assignments”A request that needs a provider can only succeed if the project has an account
assigned for it. For example, POST /captchas/resolve with provider: "capsolver"
returns 400 when the project has no Capsolver account. Assign an account for each
provider you use on the project’s page. Each provider can have at most one account
per project.
Allowed return origins
Section titled “Allowed return origins”When you connect a Gmail or Outlook mailbox,
the return_url you pass must be an absolute http(s) URL. If you list origins
here, only those origins are accepted. If the list is empty, any origin is
accepted.