Getting an API Key

Some applications that work with OccultWatcher, such as OccRep, need an API key for your account. You get the key from your user profile on OccultWatcher Cloud. It takes a minute, and you only need to do it once.

You need an OccultWatcher account with a verified email address. If you don't have an account yet, sign up on OccultWatcher Cloud first. Your OccultWatcher Desktop login works there too.

1. Open your User Profile

Log in to OccultWatcher Cloud. Click Welcome, your name at the top right, then choose User Profile.

The user menu at the top right, open, showing User Profile and Logout

2. Go to Permissions & Settings

Open the Permissions & Settings tab. The Status row shows whether your email address is verified.

The Permissions & Settings tab for an unverified account, with a Verify Email button

If the status is Verified, skip to step 4.

3. Verify your email address

Click Verify Email, then OK to send a verification email to your login address.

The Verify Email confirmation, with Cancel and OK buttons

A message confirms that the email was sent.

Success message: follow the steps in the email to complete the verification, then refresh this page

Open the email and follow its link. Then go back to the Permissions & Settings tab and refresh the page. The status now shows Verified.

No email after a few minutes? Check your spam folder.

4. Get your API key

Click Get API Key.

The Permissions & Settings tab for a verified account, with a Get API Key button

A message confirms API Key allocated, and the page refreshes after a moment. Your key appears in the new API Key row.

The API Key row showing the key and a copy button

5. Copy the key into your application

Click the copy button next to the key to copy it to the clipboard, then paste it where the application asks for it. You can come back to this tab to copy the key again at any time.

Keep your key private. Anyone with the key can use OccultWatcher as you. API keys are for registered and supported applications only. Misuse can get the key revoked and your account blocked. To discuss a new integration with OccultWatcher Cloud, get in touch.