Кто может использовать эту функцию?
Доступно на тарифе Enterprise.
Доступно для владельцев и администраторов в веб-приложении.
Чтобы использовать API Fax.Plus, сначала необходимо предоставить приложению API разрешение на доступ к вашей учётной записи. После завершения процесса авторизации вы сможете войти в свою учётную запись.
Существует два способа аутентификации:
- Создать и использовать персональные токены доступа.
- Использовать процесс OAuth 2.0.
Персональный токен доступа можно использовать как метод аутентификации для безопасного доступа к API Fax.Plus. Этот токен выполняет функцию цифровой подписи и позволяет отправлять авторизованные запросы к нашему API, например, отправлять факсы и получать данные по вашим факсам.
Чтобы создать новый персональный токен доступа, выполните следующие шаги:
- Войдите в свою учётную запись Fax.Plus и перейдите в раздел Настройки на панели управления.
- Найдите вкладку Интеграции.
- В разделе Fax.Plus API найдите пункт Персональные токены доступа и нажмите Управление.
- Нажмите Создать токен и укажите название токена, срок действия и области доступа (укажите на токене обе области доступа — edit и read).
- Обязательно скопируйте ваш персональный токен доступа сейчас, поскольку повторно увидеть его будет невозможно.
Шаг 1: Настройка начального процесса аутентификации
- Войдите в свою учётную запись Fax.Plus и перейдите в раздел Настройки на панели управления.
- Найдите вкладку Интеграции.
- В разделе Fax.Plus API нажмите Активировать и получите следующие данные:
- Client ID (начинается с APIK-)
- Client secret
- Redirect URI (один из них)
- Чтобы начать процесс предоставления API доступа к вашей учётной записи, просто перейдите по указанной на этом шаге ссылке в браузере. Эта ссылка перенаправит вас на страницу, где можно предоставить необходимые разрешения: https://accounts.fax.plus/login?response_type=code&client_id=[client ID]&redirect_uri=[redirect URI]&scope=all
-
После предоставления разрешения вы будете перенаправлены на указанный вами URL-адрес вместе с кодом авторизации в качестве параметра URL-адреса:
Шаг 2: Отправка HTTP POST-запроса
После успешной авторизации доступа вы можете выполнить HTTP POST-запрос по следующему URL-адресу: https://accounts.fax.plus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI].
Обязательно включите в запрос следующие заголовки:
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
- Content-Type: application/x-www-form-urlencoded
После завершения вы получите ответ с токеном доступа, который действителен в течение 1 часа, а также с токеном обновления неограниченного срока действия.
Примечание: если в вашей учётной записи Fax.Plus активирована функция Advanced Security Controls, токен обновления действителен в течение 30 дней в соответствии с требованиями безопасности. Это означает, что каждые 30 дней вам нужно будет повторять процесс для получения нового токена обновления.
Шаг 3: Получение нового токена доступа
После истечения срока действия токена доступа вы можете получить новый с помощью токена обновления через HTTP POST-запрос по следующему URL-адресу: https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=[refresh token].
Для этого процесса необходимо включить следующие заголовки:
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
После получения токена доступа для всех последующих вызовов API потребуются следующие заголовки:
-
- Authorization: Bearer [access token]
- x-fax-clientid: [client ID]