From the API docs to your account panel and back: the API page, keys and support

The short answer: the documentation explains; My MozOut is where you act. API keys are created, listed and revoked on the API page in My MozOut, which is also where you do everything the API does not do yet. The two are linked both ways.

What you do where

You want to...	Where
Understand how an operation works	In the documentation.
Create, see or revoke a key	In My MozOut, on the API page.
Try a request	In the documentation Playground.
Do a task the API does not cover yet	In My MozOut, as usual.
Get help	In the Knowledge Base or through a support ticket in My MozOut.

From the documentation to My MozOut

1	The top menu of the documentation has a link to My MozOut.

2	On the Get started with the API and Authentication and keys pages, the "API" link opens the key page in My MozOut directly. If you are not signed in, it asks you to sign in first and then carries on to that page.

3	The Account and security page reminds you that changes to your account details are still made in My MozOut.

From My MozOut and the website to the documentation

The API page on the website has a button that opens the documentation, and Knowledge Base articles about the API, like this one, link to the right pages.

Creating your first key, in short

1	Sign in to My MozOut and open the API page.

2	Name the key and choose the mode: Sandbox, to start with.

3	Choose the permissions and the validity.

4	Confirm with your password and the code you receive by email.

5	Copy the key: it is shown only this once.

The details of each choice are in Authentication and keys.

Do not send your key in a support ticket, an email or a chat. To find one of your requests, the X-Correlation-ID that comes with every API response is enough.

Ready to create your key? The API page in My MozOut asks you to sign in and takes you there.

Open the API page

Categories

Categories