API

Тем партнёрам, кто интегрирует личный кабинет с другими сервисами, в разделе «О парке» → «API» можно создавать API-ключи и управлять ими, не обращаясь в техподдержку.

API позволяет настроить обмен информацией между личным кабинетом и другими сервисами, с которыми вы работаете в таксопарке.

С помощью API можно:

• Заводить, редактировать и выгружать информацию по водителям/курьерам или автомобилям и использовать её для формирования собственных отчетов.
• Настраивать выплаты и списания с баланса Яндекс Про.
• По-другому использовать данные из личного кабинета, чтобы автоматизировать работу таксопарка.

Добавить счет (интеграцию) для «Моментальных выплат» через Яндекс Про можно в разделе «Счета для моментальных платежей».

Особенности работы с ключами

• Храните созданные ключи так, чтобы у третьих лиц не было к ним доступа.
• Если есть подозрение, что ключ получили третьи лица, нужно сразу деактивировать его и создать новый.
• Устанавливайте только необходимый набор разрешений для каждого ключа.
• Создавать, редактировать и деактивировать ключи может только пользователь с ролью «Директор».

Как создать API-ключ

Создать API может только сотрудник с ролью «Директор» в «Разрешениях» API-ключа. Для этого в «О парке» выберите раздел API и проставьте галочки в нужных пунктах.

Подробнее по пунктам:

1. Перейдите в раздел «О парке» → «API».

2. Нажмите кнопку «+». Справа появится раздел, где можно настроить разрешения для ключа и добавить комментарии.

3. Дайте ключу понятное название в поле «Комментарий» — чтобы не забыть, для чего вы его создавали, и ориентироваться среди ключей для других интеграций.

4. Проставьте галочки напротив пунктов, к которым ключу нужен доступ.

5. Нажмите кнопку «Сохранить». Появится окно, содержащее:

   Client ID: идентификатор клиента для использования в заголовке запроса к API.

   API KEY: авторизационный токен — сам ключ для API.

   Park ID: идентификатор партнера (вашего личного кабинета), который нужно использовать совместно с ключом для API.

Когда вы закроете окно, данные нельзя будет нигде посмотреть. Поэтому обязательно сохраните их в надежном месте.

Как отредактировать разрешения ключа и комментарий к нему

1. Нажмите на строку в таблице ключа, который хотите отредактировать. Появится окно для редактирования параметров.
2. Измените параметры и нажмите кнопку «Сохранить».

Как деактивировать ключ для API

1. Нажмите на строку в таблице ключа. Появится окно для редактирования параметров.
2. В поле «Состояние» выберите значение «Выключенный» и нажмите кнопку «Сохранить».

По вопросам, связанным с работой API, вы можете обращаться по адресу api-taxi@yandex-team.ru.

Более подробно о возможностях API вы можете узнать в документации.