# API

API (программный интерфейс приложения) позволяет организовать интеграцию сторонних сервисов и приложений с сервисом Senler.

### Синтаксис запросов

Чтобы обратиться к методам API Senler, необходимо отправить запрос на адрес:**`https://senler.ru/api/METHOD_NAME`**

где **METHOD\_NAME** — название [метода API](https://help.senler.ru/senler/help/razrabotchikam/api/methods).

### Параметры

Все данные передаются методом POST в теле запроса (body) с типом `multipart/form-data` или `json`. Каждый метод имеет свои обязательные и необязательные параметры. Всегда с каждым запросом необходимо передавать следующие параметры: 

* **vk\_group\_id или tg\_group\_id** — идентификатор канала ВКонтакте или Telegram соответственно. (Также допускается использование **group\_id**. Взять его можно из ссылки на главную страницу канала. Пример ссылки: <https://senler.ru/cabinet/home/_\\>\<group\_id>\_).
* **v** — версия API Senler. Использование этого параметра применяет некоторые изменения в формате ответа различных методов. На текущий момент [актуальная версия API — 2](https://help.senler.ru/senler/help/razrabotchikam/api/versii-api).
* **access\_token** — [ключ доступа](https://help.senler.ru/senler/help/razrabotchikam/api/klyuchi-dostupa).

### Пример

Пример кода для обращения к методу API Senler.

{% tabs %}
{% tab title="PHP" %}

```php
$params = [
    'vk_group_id' => 123456,
    'access_token' => "XXXXXX",
    'v' => 2,
    'subscription_id' => 123,
    'utm_id' => 456,
    'force' => 1,
];

$myCurl = curl_init();
curl_setopt_array($myCurl, [
    CURLOPT_URL => "https://senler.ru/api/utms/getLink",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => http_build_query($params)
]);

$response = curl_exec($myCurl);
curl_close($myCurl);
```

{% endtab %}

{% tab title="Python" %}

```python
r = request.post('https://senler.ru/api/utms/getLink', data = {
    'vk_group_id' => 123456,
    'access_token' => "XXXXXX",
    'v' => 2,
    'subscription_id' => 123,
    'utm_id' => 456,
    'force' => 1
})
r.json()
```

{% endtab %}
{% endtabs %}

Ответ на запрос в формате JSON:

```
{
    'success': true,
    'link': "https://vk.com/app5898182_-123456#s=123&u=456&force=1"
}
```