Register your app

To get OAuth tokens for managing access to Yandex users' data, the developer needs to register their app in Yandex OAuth. After registration, the app will be available for editing in the Yandex OAuth control panel.

Step 1. Creating an app

1. Log in to Yandex OAuth with the Yandex account you're planning to use for further development.

2. Click Create app or follow this link: https://oauth.yandex.com/client/new/id/.

   Alert

   To create an app that works with data from other Yandex services (for example, Yandex Tracker or Yandex Metrica), follow this link: https://oauth.yandex.com/client/new/.

   Under Data access, enter permission names pertaining to the relevant Yandex service.

3. Specify app details:

   1. Enter your Service name.
      The user will see this name on the authorization page and in the list of apps with access to their account.

   2. If your service has a logo, click Attach icon and select an image up to 1 MB in size.
      The user will see this icon on the authorization page and in the list of apps with access to their account.

   3. Under Platforms, select one or more platforms your app runs on:

      • Web services to set up authorization on a website.
      • iOS app to set up authorization in an app for iOS devices.
      • Android app to set up authorization in an app for Android devices.

      You can specify the platform parameters later.

4. Click Save and continue.

Step 2. Permissions

1. Select what user data the app should have access to:

   • Username, first name, last name, and gender.
   • User avatar.
   • Email address.
   • Phone number.
   • Date of birth.

   The user will see the list of granted data on the authorization page and in the list of apps with access to their account.

2. Click Save and continue.

Step 3. Platforms

1. Specify the parameters of the platforms your app runs on:

   • Web services:

     • Redirect URI. The URL to redirect the user to after they grant your app access. This URL corresponds to the redirect_uri parameter of the OAuth protocol.

       Fill in this field depending on the method you've selected to obtain an OAuth token. For example, if you use the instant authorization technology (recommended for web services), enter the URL of the auxiliary page you'll create to receive the token. When using debug tokens to develop and test apps, click Enter URL for debugging in the tooltip box. A URL that allows you to obtain debug tokens will be pasted into the field.

       Note

       Don't use local addresses in the Redirect URI field.

     • Click to enter multiple addresses. You can use different addresses when the website allows different authorization scenarios, such as when you need to set up multiple environments. You can select the appropriate address when you get the OAuth token.

   • iOS app:

     • iOS Appid. The exact ID of the iOS app, such as A1B2C3D4E5.com.domain.application. It consists of a Prefix and a Bundle ID. Learn more about iOS app IDs in the Apple documentation.

     • iOS AppStore URL. A link to the app in App Store.

   • Android app:

     • Android package name. The app package name from the applicationId field in the build.gradle file of your module. Learn more about Android app IDs in the Android documentation.

     • Android Google Play URL. A link to the app in Google Play.

     • SHA256 Fingerprints. Your app's certificate fingerprint. See the Android documentation to learn how to generate such a fingerprint.

   Note

   If you're developing an app for iOS or Android, use SDK Yandex ID to get the OAuth token.

2. Click Save and continue.

Step 4. Email address

1. Enter the email address to be used for sending you information about changes in Yandex ID or about updated external authorization parameters.

2. Click Save.

Completing registration

After all the app parameters are set, a window will appear in Yandex OAuth that users will see when logging in to your app via Yandex ID. To confirm saving, click Everything is correct.

To further set up a connection to API Yandex ID (to request the OAuth token and user information), use the parameters specified on the app page accessed from the Yandex OAuth control panel.