Авторизация при интеграции по API: различия между версиями

Материал из Касса
Перейти к навигации Перейти к поиску
Строка 2: Строка 2:
'''API''' (Application Programming Interface или интерфейс программирования приложений) — это совокупность инструментов и функций в виде интерфейса для создания новых приложений, благодаря которому одна программа будет взаимодействовать с другой.
'''API''' (Application Programming Interface или интерфейс программирования приложений) — это совокупность инструментов и функций в виде интерфейса для создания новых приложений, благодаря которому одна программа будет взаимодействовать с другой.


* Для работы с API сервиса БИФИТ Касса, пользователю необходимо получить токен доступа ('''access_token''').  
Для работы с API сервиса БИФИТ Касса, пользователю необходимо получить токен доступа. Генерация токена происходит по правилам авторизации OAuth2.
* Генерация токена происходит по правилам авторизации Oauth2.
 
 
Токены предоставляют собой средство авторизации для каждого запроса от клиента к серверу. Токены (и соответственно сигнатура токена) генерируются на сервере основываясь на секретном ключе(который хранится на сервере) и payload'e. Токен хранится на клиенте и используется при необходимости авторизации какого-либо запроса.
 
Основные функции:
* Аутентифицировать пользователей, используя внутреннее хранилище пользователей или внешний источник (например, Active Directory)
* Управлять клиентами (хранить) и аутентифицировать их
* Предоставлять управление сессией и возможность реализации Single sing-on
* Выдавать identity-токены и access-токены клиентам
* Проверять ранее выданные токены
 


Информация получаемая по OAuth2:
Информация получаемая по OAuth2:
Строка 24: Строка 12:
'''expires_in''' - время работы (протухания) access_token в секундах. В сервисе БИФИТ Бизнес составляет 12 часов или 43 200 секунд - 1 секунда = 43 199 секунд.
'''expires_in''' - время работы (протухания) access_token в секундах. В сервисе БИФИТ Бизнес составляет 12 часов или 43 200 секунд - 1 секунда = 43 199 секунд.


{{Note|
{{Note|'''Внимание'''
Учетная запись от имени которой будут происходить работа по API должна иметь максимальное кол-во прав, для создания, редактирования или удаления документов и справочников БИФИТ Касса|
Учетная запись от имени которой будут происходить работа по API должна иметь максимальное кол-во прав, для создания, редактирования или удаления документов и справочников БИФИТ Касса|
700}}
700}}

Версия 11:26, 3 февраля 2022

Общие сведения

API (Application Programming Interface или интерфейс программирования приложений) — это совокупность инструментов и функций в виде интерфейса для создания новых приложений, благодаря которому одна программа будет взаимодействовать с другой.

Для работы с API сервиса БИФИТ Касса, пользователю необходимо получить токен доступа. Генерация токена происходит по правилам авторизации OAuth2.

Информация получаемая по OAuth2:

access_token — авторотационный ключ (обычно просто набор символов), предъявление которого является пропуском к защищенным ресурсам. Обращение к ним в самом простом случае происходит по HTTPS. Используется при работе по API

refresh_token — ключ, по которому можно получить access token с помощью HTTP-запроса, аналогично авторизации по логину и паролю

expires_in - время работы (протухания) access_token в секундах. В сервисе БИФИТ Бизнес составляет 12 часов или 43 200 секунд - 1 секунда = 43 199 секунд.

Note.svg Внимание Учетная запись от имени которой будут происходить работа по API должна иметь максимальное кол-во прав, для создания, редактирования или удаления документов и справочников БИФИТ Касса

Авторизацию в OAuth2 по паролю

Подготовьте POST запрос следующего вида: 

 URL: https://kassa.bifit.com/cashdesk-api/v1/oauth/token

body запроса передаваться как Content-Type: form-data и содержать следующие параметры: 

"grant_type" : "password"
"username" : номер телефона (вводится как 79999999999)
"password" : вставить скопированный Access_token
"client_id" : "cashdesk-rest-client"
"client_secret" : "cashdesk-rest-client"

После этого нажмите кнопку Send.

Авторизацию в OAuth2 по refresh_token

Авторизацию в OAuth2 при двухфакторной авторизации

Источник — http://kassa.bifit.com/wiki/index.php?title=Авторизация_при_интеграции_по_API&oldid=7124