Settings: SDK and key
Get the SDK, copy your API key, see whether Atlas has seen a sign-in from your program, and look up what an error message means.
Open it now:Settings, SDK and key
What this tab is for
It is the tab to open when you wire Atlas into a program for the first time, and the first one to check when a sign-in fails. From top to bottom: the SDK download, the API key, the connection check, the quick start, and the error lookup.
Download the SDK
One button per language, each opening that SDK's repository on GitHub: C++, JavaScript and Python. The same buttons are in the setup checklist on Overview, on Help and in the help menu. Install and first sign-in walks through using one.
Your API key
The API key tells Atlas which application a request belongs to. You set it in your code as Atlas::API_KEY before Startup(). It is 64 letters and digits, and anyone who holds it can ask Atlas to sign people in to your application, so keep it out of git, chat and screenshots.
| Control | What it does |
|---|---|
| Reveal | The first time, a warning dialog asks you to confirm; then the key is fetched and shown. Until then it is blurred. Hide blurs it again without a warning. |
| Copy | Appears once the key has been revealed. Copies it. |
| Rotate key | Makes a new key and invalidates the old one at once. See below. |
Only the owner of the application can reveal or rotate the key. A reseller or a staff member opening the same application does not get it.
Revealing the key here or in the quick start remembers it in this browser, so the next reveal does not ask the server again. Clearing the site's data in your browser forgets it.
Rotate the key
Rotate when a key leaks, not for tidiness. The old key stops working immediately, so every build that carries it is refused until you rebuild with the new key.
- Press Rotate key, then Email verification link. The link goes to your account's email address and is valid for 10 minutes.
- Open the link, on this computer or any other. The dialog notices within a few seconds and shows Email verified.
- Press Reset API Key. The new key is shown and copied to your clipboard.
Then put the new key in your code, rebuild, and authorize the new build if you use the build list. You can reveal the new key again later from this tab.
The connection check
The card under the key reads the application's own data and says whether a client has signed in. The heading is Connected once a successful sign-in appears in the newest 40 log rows, and Not connected yet until then. While it is not connected, the card looks again every 8 seconds for up to ten minutes after you opened the tab, so you can run your program and watch it change. Check again looks immediately.
| Row | Means |
|---|---|
| Application is on / switched off | A switched-off application refuses every sign-in. The button opens General. |
| You have something to sign in with | At least one license or account exists. If none does, the button opens Users. |
| A client has signed in | A successful sign-in is on record, and how long ago the last one was. |
| Executable check | Reads the alert rule on unauthorized_hash. Rule on with an empty hash list: every sign-in is refused. Rule on with N hashes: only those builds sign in, and a rebuild is refused until its hash is added. Rule off: any build can sign in. |
Below the rows, the newest five refused sign-ins are listed with the exact text the server logged, what that usually means, the fix, and a button to the page where you make the fix.
Quick start
Pick C++, JavaScript or Python (the choice is remembered). Step 1 is the install command or the files to copy, step 2 is the key, step 3 is a sign-in snippet. Reveal API key in step 2 asks for the same confirmation as above and then fills your key into the snippet, which you can copy with Copy. Create a license to test with in Users.
What an error means
A searchable list of the messages a client can show, in three groups, each with what it means and what to do:
| Group | Messages |
|---|---|
| The key or account | Invalid license, expired, license paused, banned (temporary or permanent), hardware banned. |
| The machine or network | Hardware ID mismatch, IP mismatch, too many sessions, VPN detected, geofence violation or blocked country, time sync, rate limit. |
| The application or the build | Application disabled, hash mismatch, invalid or malformed request, replay attack, config error. |
Every message can be reworded in Messages. A short list of other problems follows, each opening to an answer: 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.