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 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

After you create your developer account, it's time to create an app to get your API key.

  1. Open the Developer Console.

  2. On the Applications page, click Create application, enter the same name as your project, and then click Create. The app is created.

  3. Your API key is now ready to use. To obtain it, select More > Copy API key.

    Or open the app and find the API key under Information > KEY.

Regenerate API key

You can regenerate your API key by clicking Regenerate API key. If an API key is regenerated, the old key expires and can no longer be used for authentication. You need to use the new key to access the API.

Add information about your app

  1. Open the Developer Console.

  2. Select your app and then click Edit.

  3. Fill out the general information about your app. This info is displayed across all Sky Mavis services with which you integrate. When done, click Save.

This completes your app's setup.

Request access to products and services

Sky Mavis offers a range of services that enhance your integration experience and provide additional features for your users. To access these services, you need to make a request through the Developer Console. This guide uses the Sky Mavis Account service as an example, but the process is the same for any service that requires an access request.

  1. Open the Developer Console.

  2. Select your app and then open the App Permission tab.

  3. Locate the service you need access to, and then click Request Access.

  4. Provide a brief explanation of why you require access to the service, and then click Submit request.

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

See also

Services

Was this helpful?