Registering an app

To get OAuth tokens to work with Yandex users' data, the developer needs to register their app in Yandex OAuth.

Step 1. Creating an appStep 1. Creating an app

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

2. Click Create app or follow the direct link.

3. Specify app data:

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

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

   3. Under Platforms, choose one or more platforms your app works on:

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

      You can specify the app parameters later.

4. Click Save and continue.

Step 2. Data accessStep 2. Data access

1. Choose user data to provide the app access to:

   • Login, first name, last name, and gender.
   • User's profile picture.
   • Email address.
   • Phone number.
   • Date of birth.

   The user will see the list of provided data on the authorization page and in the list of the apps that got access to their account.

2. Click Save and continue.

Step 3. App platformsStep 3. App platforms

1. Specify parameters of the platforms your app works on.

   • Web services:

     • Redirect URI. The URL to redirect the user to after they allow access to the app. The address corresponds to the redirect_uri parameter of the OAuth protocol.
       If you want to get debug tokens for this app, click Set URL for debugging in the suggestion window that appears. The field will be filled with a test URL you can use to get debug tokens.

     • To specify multiple addresses, click and enter the address. When requesting an OAuth token, specify the URL using the redirect_uri parameter.

       Different addresses can be used if the website allows authorization using different scenarios. For example, if you need to set up multiple environment types.

   Note

   If you're developing a web service, you can choose a method for obtaining an OAuth token to work with Yandex users' data that suits you best:

   • iOS app:

     • iOS Appid. The exact ID of the iOS app - for example, A1B2C3D4E5.com.domain.application. Consists of Prefix and Bundle id. Learn more about iOS app IDs in the Apple documentation.

     • iOS AppStore URL. Link to the app in the AppStore.

   • Android app:

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

     • Android Google Play URL. Link to the app in Google Play.

     • SHA256 Fingerprints. The certificate fingerprint of your app. Learn more about generating a fingerprint in the Android documentation.

   Note

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

2. Click Save and continue.

Step 4. Email addressStep 4. Email address

1. Enter the email where you would like to receive information about changes in Yandex ID or external authorization parameter updates.

2. Click Save.

Completing registrationCompleting registration

After setting up all the app's parameters, 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 set up connection to API Yandex ID further (request an OAuth token and user information), use the parameters specified on the app page in the Yandex OAuth personal account.