General connection procedure

1. Go to the management console.

2. On the left side of the screen, click the line with the name of the folder where you want to create a service account.

3. In the list of services, select Identity and Access Management.

4. Click Create service account.

5. Enter a name for the service account.

   The name format requirements are as follows:

   • The name must be from 3 to 63 characters long.
   • It may contain lowercase Latin letters, numbers, and hyphens.
   • The first character must be a letter and the last character cannot be a hyphen.

   Make sure the service account name is unique within your cloud.

6. Click Create.

1. In the management console, select the appropriate folder.
2. Go to the Access bindings tab.
3. Click Configure access.
4. In the window that opens, select Service accounts.
5. Select a service account from the list or use the search.
6. Click Add role and select the role in the folder.
7. Click Save.

1. In the management console, navigate to the folder the service account belongs to.
2. In the list of services, select Identity and Access Management.
3. In the left-hand panel, select Service accounts.
4. Select the service account to create an API key for. Create a new service account if needed.
5. In the top panel, click Create new key and select Create API key.
6. Enter a description of the key so that you can easily find it in the management console.
7. (Optional) Select Scope. For more information about scopes, see API keys with scope and validity limits.
8. (Optional) Specify Validity period.
9. Click Create.
10. Save the ID and the secret key.

1. In the management console, select the folder you are going to use to work with Search API or create a new one.

2. In the list of services, select Search API.

3. Fill in the form fields:

   • Select the Search type: Russian, Turkish, or International.

   • Set at least one trusted IP address to send requests to the Yandex search database from.

     You can send requests to Search API's API v1 only from one of the IP addresses added to the service settings during registration. Attempts to run a request from a non-registered IP address will be rejected.

4. Click Save.

After that, you will be able to change the search type and the trusted IP address list. In the management console, go to the Search API service and click Edit in the top-right corner.

1. In the management console, select the folder you are going to use to work with Search API.

2. In the list of services, select Search API.

3. In the left-hand panel, select Test queries.

4. Select a Request method (GET and POST methods are supported) and fill in the form fields.

   Note

   You cannot edit the Search query text in a test query. Queries are submitted from a Yandex IP address on behalf of the service.

   As the values in the form fields change, the search query URL for the specified values will be formed in the Search query field. If you select the POST method, a relevant query body will be formed in the Request body field.

5. Click Run test. The query execution result will be displayed below.

6. If necessary, change the parameters to adjust the search results and resubmit your query.