Skip to main content

Get started

Overview

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

Sign up for a developer account

A developer account gives you access to the Developer Console—the central place for managing your app and services you use.

  1. Go to Developer Console at https://developers.skymavis.com/console.
  2. Create an account using your email address or the social login feature.
  3. Enter the verification code sent to your email.
  4. Optionally, complete a short survey.

Your Sky Mavis developer account is ready to use.

Create an app

Creating an app in the Developer Console generates an API key that you can use to authenticate requests to the Sky Mavis APIs. It also gives you an app ID.

To create an app, follow these steps:

  1. Go to Developer Console > Create application.
  2. Enter the app name, then click Create.
  3. Select the app you created, then click Edit, and then fill in the app details, including the app description, website, and logo.
  4. Click Save.

Your app is now created and you can view the API key and app ID on the Information tab.

If you need to regenerate the API key, click Back to applications, then click More options (three dots) next to your app, and then select Regenerate API key.

Make sure to replace the old key with the new one in your app code or environment variables.

Request access to services

Some services require that you request access before you can use them. To request access, follow these steps:

  1. Go to Developer Console > your app > App Permissions, then locate the service you want to use, and then click Request Access.

  2. Describe your potential use case with this service, and submit the request.

If Sky Mavis approves your request, the service's status changes to "Active."

See also

List of products and services