Settings: SDK and key
Get the SDK, copy your API key into your program, and watch Atlas confirm it can reach it.
Open it now:Settings, SDK and key
Download the SDK
The card at the top of the page has one button per language, each going straight to that SDK's repository on GitHub: C++, JavaScript and Python. The same buttons are in the setup checklist, on the Help page and in the help menu. Install and first sign-in walks through using one.
Your API key
The API key tells Atlas that a request comes from your program and not from another developer's build. It goes in your code as Atlas::API_KEY before Startup(). Reveal shows it (it is blurred until you press the button) and Copy copies it. Treat it like a database password: anyone holding it can ask Atlas to sign people in as your application.
Rotate key makes a new one after an email confirmation. The old key stops working at once, so every build that carries it is refused until you rebuild with the new key and authorize that build. Rotate when a key leaks, not for tidiness. The idea behind the key is in API keys.
The connection check
Under the key, Atlas checks the application from its own data and says whether it is connected. It looks again every 8 seconds for up to ten minutes while it waits for your first sign-in, so you can run your program and watch the result change. Check again forces a look.
| Check | Means |
|---|---|
| The application is on | It is not disabled. A disabled application refuses every sign-in. |
| You have something to sign in with | At least one license or account exists. |
| A client has signed in | A successful sign-in is on record, and when the last one was. |
| The build check | Whether the authorized list is empty (everyone is refused), and what it will do to a rebuilt program, which has a new hash. |
Beneath it, recent refusals are listed with the cause and a button that opens the page that fixes it.
Quick start with your key
Pick C++, JavaScript or Python. The page shows the install step and a working sign-in example with your API key already in it (the key is filled in after you reveal it, and remembered in this browser). Copy it, paste your own license key, run it, and the connection check turns green.
Errors and what to do
The page ends with the messages a client can show, grouped by cause: the key or account, the machine or network, and the application or the build. Each gives what it means and the fix, with a search box. A short list of common problems follows: the program closes right after Startup(), Login returns false, Atlas.dll not found, an unsupported platform, it worked until a rebuild, and a key set from an environment variable that is empty.