CASHDESK API:Авторизация на сервере ЖКХ: различия между версиями
Перейти к навигации
Перейти к поиску
Merkulov (обсуждение | вклад) Метка: ручная отмена |
Merkulov (обсуждение | вклад) |
||
| (не показано 10 промежуточных версий этого же участника) | |||
| Строка 3: | Строка 3: | ||
'''API''' (Application Programming Interface или интерфейс программирования приложений) — это совокупность инструментов и функций в виде интерфейса для создания новых приложений, благодаря которому одна программа будет взаимодействовать с другой. | '''API''' (Application Programming Interface или интерфейс программирования приложений) — это совокупность инструментов и функций в виде интерфейса для создания новых приложений, благодаря которому одна программа будет взаимодействовать с другой. | ||
Для работы с API сервиса Касса ЖКХ, пользователю необходимо получить токен доступа. Генерация токена происходит по правилам авторизации OAuth2 | Для работы с API сервиса '''Касса ЖКХ''', пользователю необходимо получить токен доступа. Генерация токена происходит по правилам авторизации OAuth2. | ||
== Авторизация на сервере ЖКХ == | == Авторизация на сервере ЖКХ == | ||
| Строка 9: | Строка 9: | ||
Для начала работы в приложении Касса ЖКХ необходимо прописать на сервере учетную запись. | Для начала работы в приложении Касса ЖКХ необходимо прописать на сервере учетную запись. | ||
{{ProductTable-2 | |||
|title-left='''Запрос''' | |||
|title-right='''POST''' | |||
|content-left= URL: https://<URL-адрес сервера>/OAuth/token | |||
|content-right= | |||
<syntaxhighlight> | |||
https://<URL-адрес сервера>/OAuth/token | |||
</syntaxhighlight> | |||
|}}<br> | |||
{{ProductTable-2 | |||
|title-left= Request Body | |||
|title-right= type: '''x-www-form-urlencoded''' | |||
|content-left= | |||
* '''grant_type''': передать значение ''"password"' | |||
* '''username''': логин учетной записи, передается в формате '''7xxxxxxxxxx''' | |||
* '''password''': пароль, передается в виде зашифрованного хэш -> '''SHA-256 -> base64 urlencoded''' | |||
* '''client_id''': передать значение ''"communal-rest-client"'' | |||
* '''client_secret''': передать значение ''"communal-rest-client"'' | |||
|content-right= | |||
<syntaxhighlight lang="JSON"> | <syntaxhighlight lang="JSON"> | ||
"grant_type" : "password", | "grant_type" : "password", | ||
"username" : | "username" : "7xxxxxxxxxx", | ||
"password" : | "password" : "asdaldfkhj34o.......kljslkfas=", | ||
"client_id" : "communal-rest-client", | "client_id" : "communal-rest-client", | ||
"client_secret" : "communal-rest-client" | "client_secret" : "communal-rest-client" | ||
</syntaxhighlight> | </syntaxhighlight> | ||
|}}<br> | |||
{{Note|'''Обратите внимание'''<br> | {{Note|'''Обратите внимание'''<br> | ||
* Пароль передается в виде хэш суммы. Необходимо зашифровать пароль при помощи алгоритма '''SHA256''' и затем закодировать полученные данные по стандарту '''Вase64 urlencoded'''. | * Пароль передается в виде хэш суммы. Необходимо зашифровать пароль при помощи алгоритма '''SHA256''' и затем закодировать полученные данные по стандарту '''Вase64 urlencoded'''. | ||
* При вводе пароля, в конце поставить знак {{Знак равенства}}, без этого запрос будет считаться неверным. | * При вводе пароля, в конце поставить знак {{Знак равенства}} (без пробела), без этого запрос будет считаться неверным. | ||
|700}} | |700}} | ||
Текущая версия на 12:53, 1 июня 2022
CASHDESK API
API (Application Programming Interface или интерфейс программирования приложений) — это совокупность инструментов и функций в виде интерфейса для создания новых приложений, благодаря которому одна программа будет взаимодействовать с другой.
Для работы с API сервиса Касса ЖКХ, пользователю необходимо получить токен доступа. Генерация токена происходит по правилам авторизации OAuth2.
Авторизация на сервере ЖКХ
Для начала работы в приложении Касса ЖКХ необходимо прописать на сервере учетную запись.
| Запрос | POST |
| URL: https://<URL-адрес сервера>/OAuth/token | https://<URL-адрес сервера>/OAuth/token |
| Request Body | type: x-www-form-urlencoded |
|
"grant_type" : "password",
"username" : "7xxxxxxxxxx",
"password" : "asdaldfkhj34o.......kljslkfas=",
"client_id" : "communal-rest-client",
"client_secret" : "communal-rest-client"
|
Обратите внимание
- Пароль передается в виде хэш суммы. Необходимо зашифровать пароль при помощи алгоритма SHA256 и затем закодировать полученные данные по стандарту Вase64 urlencoded.
- При вводе пароля, в конце поставить знак = (без пробела), без этого запрос будет считаться неверным.