API
В разделе «Настройки» → API можно создавать API-ключи и управлять ими, не обращаясь в техподдержку. Это будет полезно тем, кто интегрирует личный кабинет с другими сервисами. API позволяет настроить обмен информацией между личным кабинетом и другими сервисами, с которыми вы работаете в таксопарке.
В разделе «Настройки» → API можно создавать API-ключи и управлять ими, не обращаясь в техподдержку. Это будет полезно тем, кто интегрирует личный кабинет с другими сервисами.
API позволяет настроить обмен информацией между личным кабинетом и другими сервисами, с которыми вы работаете в таксопарке.
С помощью API можно:
- Выгружать информацию по водителям или доставщикам и использовать её для формирования собственных отчетов.
- Настраивать выплаты и списания с баланса Яндекс Про.
- По-другому использовать данные из личного кабинета, чтобы автоматизировать работу таксопарка.
Особенности работы с ключами
-
Храните созданные ключи так, чтобы у третьих лиц не было к ним доступа.
-
Если есть подозрение, что ключ получили третьи лица, нужно сразу деактивировать его и создать новый.
-
Устанавливайте только необходимый набор разрешений для каждого ключа.
-
Создавать, редактировать и деактивировать ключи может только пользователь с ролью «Директор».
О ролях и настройках прав доступов рассказали в статье «Управление доступом».
Как создать API-ключ
Создать ключ можно за 2 минуты:
-
Перейдите в раздел «Настройки» → API.
-
Нажмите кнопку «+». Справа появится раздел, где можно настроить разрешения для ключа и добавить комментарии.
-
Дайте ключу понятное название в поле «Комментарий» — чтобы не забыть, для чего вы его создавали, и ориентироваться среди ключей для других интеграций.
-
Проставьте галочки напротив пунктов, к которым ключу нужен доступ.
-
Нажмите кнопку «Сохранить». Появится окно, содержащее:
Client ID: идентификатор клиента для использования в заголовке запроса к API.
API KEY: авторизационный токен — сам ключ для API.
Park ID: идентификатор партнера (вашего личного кабинета), который нужно использовать совместно с ключом для API.
Когда вы закроете окно, данные нельзя будет нигде посмотреть. Поэтому обязательно сохраните их в надежном месте.
Как отредактировать разрешения ключа и комментарий к нему
- Нажмите на строку в таблице ключа, который хотите отредактировать. Появится окно для редактирования параметров.
- Измените параметры и нажмите кнопку «Сохранить».
Как деактивировать API-ключ
- Нажмите на строку в таблице ключа. Появится окно для редактирования параметров.
- В поле «Состояние» выберите значение «Выключенный» и нажмите кнопку «Сохранить».
По вопросам, связанным с работой API, вы можете обращаться по адресу api-taxi@yandex-team.com