App registration
The registration procedure is completed by the app developer and includes two stages:
Registering your app with Yandex ID
Open the Create an app page and select For API access or debugging. Fill in the fields:
-
Your service's name: You can specify any name.
-
Contact email: Specify your preferred email address.
-
Data access: Add a data source to manage your ads:
-
Working with Yandex ID organizations (passport:business), to get access to authorization on behalf a Yandex ID organization.
-
Using the Yandex Direct API (direct:api): Get access to managing advertising and promotional content.
Start typing the name and select an option from the list.
-
Click Create app. After you register, Yandex ID generates and displays a ClientID and Client secret on the page. You need to specify the ClientID when creating a request for API access. The ClientID and Client secret are required to obtain an access token that authorizes the application to access a specific user's data.
Your list of registered apps is available at https://oauth.yandex.ru/. You can view the app's ClientID and Client secret, change app parameters, or remove the app.
Creating a request for API access
-
Log in on Yandex with the app developer's username.
-
Go to the My requests page on the API settings page.
Alert
To get access to the API settings page, you must create at least one campaign in the Yandex Direct web interface.
The first time you open the API settings page, you must accept the user agreement.
-
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' actual campaigns and access 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.
-
On the request creation form:
- Select the ClientID assigned during registration with Yandex ID.
- 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 review process takes up to 7 days. Following the review, your request will either be 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
Alert
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 numer 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.