Кто может использовать эту функцию?
Доступно наEnterprise плане.
Доступно для владельцев и администраторов в веб-приложении.
Чтобы использовать Fax.Plus API, вы должны сначала предоставить разрешение API для доступа к вашей учетной записи. После завершения процесса авторизации вы можете войти в свою учетную запись.
Существует два различных метода аутентификации:
- Создавать и использовать персональные токены доступа.
- Используйте поток OAuth 2.0.
Персональный токен доступа может использоваться в качестве метода аутентификации для безопасного доступа к факсу.Plus API. Этот токен служит цифровой подписью, позволяющей вам делать авторизованные запросы в нашем API, поддержка таких действий, как отправка факсов и получение данных на факсы.
выполните следующие шаги для создания нового персонального токена доступа:
- Войдите в свою учетную запись Fax.Plus и перейдите в раздел Profileна вашей панели управления.
- Найти вкладку для Integrations.
- В разделе FAX.PLUS APIнайдите элемент для токены персонального доступаи нажмите на Управление.
- Нажмите на Generate Tokenи укажите имя токена (, expiration date, и scopes.
- Make sure to Copy your Personal Access Token now, otherwise you won't be able to see it again.
Шаг 1: Настройка первоначального потока аутентификации
- Войдите в свою учетную запись Fax.Plus и перейдите в раздел Profileна вашей панели управления.
- Найти вкладку для Integrations.
- Под Fax.Plus API, нажмите Активироватьи собирайте следующие данные:
- ID клиента (начинается с APIK-)
- Секрет клиента
- URI перенаправления (один из них)
- Чтобы начать процесс авторизации API для доступа к вашему аккаунту, просто нажмите на ссылку на этом шаге с помощью веб-браузера. Эта ссылка перенаправит вас на подсказку, где вы можете предоставить необходимые разрешения: https://accounts.fax. lus/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. lus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI].
Обязательно включите в ваш запрос следующие заголовки:
-
- Content-Type: application/x-www-form-urlencoded
- Авторизация: Базовая [base64-кодированная строка "client_id:client_secret"]
- Content-Type: application/x-www-form-urlencoded
После завершения вы получите ответ, содержащий маркер доступа, который остается актуальным в течение 1 часа, а также токен обновления с бессрочной действительностью.
Примечание: Если ваш факс. lus account активирован расширенный контроль безопасности, токен обновления остается в течение 30 дней в соответствии с правилами безопасности. Это означает, что вам нужно повторять процесс каждые 30 дней, чтобы получить свежий токен обновления.
Шаг 3: Получить новый токен доступа
По истечении срока действия вашего ключа доступа, вы можете получить свежий токен, используя ваш запрос обновления HTTP POST по следующему URL: https://accounts. ос. lus/token?grant_type=refresh_token&refresh_token=[refresh token].
Этот процесс требует включения следующих заголовков:
-
- Content-Type: application/x-www-form-urlencoded
- Авторизация: Базовая [base64-кодированная строка "client_id:client_secret"]
После получения ключа доступа, все последующие вызовы API потребуют следующих заголовков:
-
- Authorization: Bearer [access token]
- x-факс-клиент: [ID клиента]