Get started

Overview

This guide shows to get started as a developer: create an account, create an app to get your API key, and request access to services and APIs you need.

Create a developer account

Your first step is creating a developer account on the Sky Mavis Developer Portal. A developer account gives you access to the Developer Console—the central place for managing your app and services you use.

1. Open the Developer Console.
2. Enter your email or use the social login to sign up.
3. Enter the verification code sent to your email.
4. Optionally, complete a short survey.

Your Sky Mavis developer account is ready to use.

Get your API key

To use the Sky Mavis APIs, you need an API key. To get an API key, create an app in the Developer Console:

1. Open the Developer Console.
2. On the Applications page, click Create application.
3. Enter the name of your project, and then click Create.
4. Your app is created, and your API key is ready to use.
5. To retrieve the API key, select More > Copy API key.
   
6. Alternatively, find the API key under Information > KEY.
   

To regenerate your API key, click Regenerate API key. After this, your previous key expires and can no longer be used for authentication. So make sure to update your project with the new key.

Add information about your app

1. Open the Developer Console, then select your app, and then on the Information tab, click Edit.
2. Fill out the general information about your app. This information is displayed across all Sky Mavis services with which you integrate.
3. When done, click Save.

   

This completes your app's setup.

Request access to services

Some services and APIs require access requests. To use these services, you need to request access through the Developer Console.

1. Open the Developer Console, then select your app, and then open the App Permission tab.
2. Find the product or service you need, then click Request Access.
3. Briefly describe your potential use case with this service, and submit the request.

If your request is approved, the service appears under PRODUCTS and is ready for configuration.

See also

Developer guides for services