Получение данных по организации (ЖКХ): различия между версиями

Материал из Касса
Перейти к навигации Перейти к поиску
 
(не показано 5 промежуточных версий этого же участника)
Строка 1: Строка 1:
Для получения информации об организации подготовьте GET запрос следующего вида:
== Общие сведения ==
'''API''' (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы на сервер ЖКХ осуществляются при помощи авторотационного токена - '''access_token'''. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи.


base URL: https://<URL-адрес сервера>/communal/organization/list/read


== Запрос получения данных организации ==


В '''AUTHORIZATION''' укажите значение access_token согласно:
{{ProductTable-2
 
|title-left='''Запрос'''
Bearer token : token <значение '''acces_token'''>
|title-right='''GET '''
|content-left= <br>URL: https://<URL-адрес сервера>/communal/organization/list/read
|content-right=
<syntaxhighlight>
https://<URL-адрес сервера>/communal/organization/list/read
</syntaxhighlight>
|}}<br>


{{Note|'''''Важно!'''''<br>
В '''HEADERS''' укажите значение '''access_token''' согласно:'''authorization''': Bearer <значение '''access_token'''> .|800}}


В '''PARAMS''' запроса укажите данные:


No parameters
{{Note|'''''Важно!'''''<br>
'''PARAMS''' запроса остается пустым.  |800}}




''Пример ответа на запрос''
{{ProductTable-2
|title-left= '''Response'''
|title-right=
|content-left= <br>
* '''address''': Адрес организации
* '''id''': ID организации
* '''inn''': ИНН организации
* '''kpp''': КПП Организации
* '''name''': Название организации
|content-right=
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
  [
  [
   {
   {
     "address": "string",                       // Адрес организации
     "address": "string",
     "id": 0,                                  // ID организации
     "id": <ID организации>,
     "inn": "string",                           // ИНН организации
     "inn": "string",
     "kpp": "string",                           // КПП Организации
     "kpp": "string",
     "name": "string"                           // Название организации
     "name": "string"
   }
   }
  ]
  ]
</syntaxhighlight>
</syntaxhighlight>
|}}<br>

Текущая версия на 10:49, 8 ноября 2022

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

API (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы на сервер ЖКХ осуществляются при помощи авторотационного токена - access_token. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи.


Запрос получения данных организации

Запрос GET

URL: https://<URL-адрес сервера>/communal/organization/list/read		 
https://<URL-адрес сервера>/communal/organization/list/read


Note.svg Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение access_token> .


Note.svg Важно!
PARAMS запроса остается пустым.


Response

  • address: Адрес организации
  • id: ID организации
  • inn: ИНН организации
  • kpp: КПП Организации
  • name: Название организации
 
 [
  {
    "address": "string",
    "id": <ID организации>,
    "inn": "string",
    "kpp": "string",
    "name": "string"
  }
 ]


Источник — http://kassa.bifit.com/wiki/index.php?title=Получение_данных_по_организации_(ЖКХ)&oldid=36917