Documentation

App registration

The registration procedure is completed by the app developer and includes two stages:

  1. Registration on the Yandex.OAuth service
  2. Creating a request for API access

Registration on the Yandex.OAuth service

  1. Log in on Yandex with the app developer's username.
  2. Go to https://oauth.yandex.com/client/new.
  3. In the registration form, enter the app parameters and click the Create button.

    App parameters are covered in the section Registering an application in the Yandex.OAuth guide. In the Permissions option, select the value Access to Yandex.Direct API. You can change the app parameters later.

As a result of registration, Yandex.OAuth generates and displays the app ID and password on the page. The app ID must be specified when creating a request for API access. The app ID and password are necessary for getting an access token that allows the app to access the data of a specific user.

Your list of registered apps is available at https://oauth.yandex.com/. You can find out an app's ID and password, change app parameters, or remove an app.

Creating a request for API access

  1. Log in on Yandex with the app developer's username.
  2. Go to the My requests page on the API settings page.
    Attention! 

    To get access to the API settings page, you must create at least one advertising campaign in the Yandex.Direct web interface (creating a single draft ad with one keyword is enough).

    The first time you open the API settings page, you must accept the user agreement.

  3. Click the New request button. In the menu that opens, select the type of request:
    • “Full access” — Request for full access to the Yandex.Direct API, including the ability to manage clients' real advertising campaigns and access to the Sandbox.
    • “Test access” — Request for limited access to the Yandex.Direct API that only includes access to the Sandbox, which is sufficient for developing and debugging an app. Later, a request for limited access can be changed to a request for full access.

  4. On the request form:
    • Select the app ID that was assigned during registration on the Yandex.OAuth service.
    • Enter a valid email address that you currently use.
    • In the other fields, provide the most accurate and complete information about the app as possible.
    • Confirm your compliance with the user agreement.

    Click the Send button.

The request is reviewed for up to 7 days. When a request has been reviewed, it gets the status “approved” or “rejected”.

A list of app registration requests you have created is available on the My requests tab on the API Settings page. You can track the status of requests being processed, and if a request is declined, you can find out the reasons for rejection, edit and delete requests, and also change a request for limited access to a request for full access.

Changing a request for API access

Attention! You must make sure the information entered in the API access request is correct and current. If the data changed (for example, the app developer's email address has changed, or the number of copies of the app in use has grown significantly), edit the request.

You can edit a request from the My requests tab on the API Settings page. After making changes to a request, it will be re-sent for processing. The parameters from the previous request will be effective until the new version of the request is approved.