Creating an API Connector connection

With API Connector in Yandex DataLens, you can send HTTP requests to any API on the internet. You can use such a connection only in Editor as it is not supported in QL charts or dataset-based charts.

To create an API Connector connection, follow these steps:

1. Open the page you use to create a new API Connector connection.

2. Specify the connection parameters:

   • Hostname. Specify the path to the host you will send a request to.
   • Port. Specify the API connection port.
   • URL path. Optionally, specify the path to the API (part of the URL without a protocol, host name, or port).
   • HTTPS. Enable the secure connection option if your server supports HTTPS.
   • Allowed methods. Select a method to send an HTTP request to the API. The available methods are GET and POST.
   • Public request headers and Private request headers. Add to your HTTP request the headers represented by key-value pairs. To do this, click Add, select a header, and enter its value. Private headers are stored privately in the connection settings. You cannot view any of them but you can replace them with new values.

   

3. Click Create connection.

4. Select a workbook to save your connection to or create a new one. If using legacy folder navigation, select a folder to save the connection to. Click Create.

5. Enter a name for the connection and click Create.