Получение информации о клиентах (ЖКХ) - История изменений

Merkulov: Merkulov переименовал страницу CASHDESK API:Запрос получения клиентов в Получение информации о клиентах (ЖКХ)

2022-11-08T07:48:01Z

Merkulov переименовал страницу CASHDESK API:Запрос получения клиентов в Получение информации о клиентах (ЖКХ)

← Предыдущая	Версия 10:48, 8 ноября 2022
(нет различий)

Merkulov в 08:02, 13 сентября 2022

2022-09-13T08:02:00Z

← Предыдущая		Версия 11:02, 13 сентября 2022
Строка 16:		Строка 16:

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

Merkulov в 07:24, 1 июня 2022

2022-06-01T07:24:57Z

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

Merkulov в 14:29, 31 мая 2022

2022-05-31T14:29:35Z

← Предыдущая		Версия 17:29, 31 мая 2022
Строка 47:		Строка 47:


			{{ProductTable-2
			\|title-left= '''Response'''
			\|title-right=
	~~Подготовьте POST запрос следующего вида:~~		\|content-left= <br>
			* '''id''': ID клиента
	~~base URL: https://<URL~~-~~адрес сервера>/communal/client/list/read~~		* '''name''': ФИО Клиента
			* '''personalAccount''': Номер лицевого счета
			\|content-right=
	В '''~~AUTHORIZATION~~''' ~~укажите значение access_token согласно:~~

	~~Bearer token : token~~ <~~значение~~ '''~~acces_token~~'''>


	В '''~~BODY~~''' ~~запроса передайте данные в формате JSON согласно структуре.~~

	''~~Пример JSON:~~''

	<syntaxhighlight lang="JSON">		<syntaxhighlight lang="JSON">
	{		{
	~~"apartment": "string", // Квартира~~		"id": <id клиента>,
	~~"building": "string", // Корпус~~		"name": "string",
	~~"house": "string", // Дом~~		"personalAccount": "string"
	~~"name": "string", // ФИО Клиента~~
	~~"organizationId": <id организации>, // ID организации~~
	~~"personalAccount": "string", // Номер лицевого счета~~
	~~"street": "string", // Улица~~
	~~"town": "string" // Населенный пункт~~
	}
	~~</syntaxhighlight>~~


	~~''Пример ответа на запрос:''~~

	~~<syntaxhighlight lang="JSON">~~
	{
	"id": <id клиента>, ~~// ID клиента~~
	"name": "string", ~~// ФИО Клиента~~
	"personalAccount": "string" ~~// Номер лицевого счета~~
	}		}
	</syntaxhighlight>		</syntaxhighlight>
			\|}}<br>

Merkulov в 14:26, 31 мая 2022

2022-05-31T14:26:49Z

← Предыдущая		Версия 17:26, 31 мая 2022
Строка 1:		Строка 1:
			== Общие сведения ==
			'''API''' (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы к сервису '''БИФИТ Бизнес''' осуществляются при помощи авторотационного токена - '''access_token'''. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи.


			== Запрос получения клиентов ==

			{{ProductTable-2
			\|title-left='''Запрос'''
			\|title-right='''POST'''
			\|content-left= <br>URL: https://<URL-адрес сервера>/communal/client/list/read
			\|content-right=
			<syntaxhighlight>
			https://<URL-адрес сервера>/communal/client/list/read
			</syntaxhighlight>
			\|}}<br>

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


			{{ProductTable-2
			\|title-left= '''Request body'''
			\|title-right= '''raw''' (JSON)
			\|content-left= <br>
			* '''apartment''': Квартира
			* '''building''': Корпус
			* '''house''': Дом
			* '''name''': ФИО Клиента
			* '''organizationId''': ID организации
			* '''personalAccount''': Номер лицевого счета
			* '''street''': Улица
			* '''town''': Населенный пункт
			\|content-right=
			<syntaxhighlight lang="JSON">
			{
			"apartment": "string",
			"building": "string",
			"house": "string",
			"name": "string",
			"organizationId": <id организации>,
			"personalAccount": "string",
			"street": "string",
			"town": "string"
			}
			</syntaxhighlight>
			\|}}<br>





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

Merkulov в 14:27, 23 марта 2022

2022-03-23T14:27:15Z

@@ Строка 23: / Строка 23: @@
    "street": "string",                                        // Улица
    "town": "string"                                           // Населенный пункт
+  }
 </syntaxhighlight>

Merkulov в 14:23, 23 марта 2022

2022-03-23T14:23:56Z

← Предыдущая		Версия 17:23, 23 марта 2022
Строка 1:		Строка 1:
	Подготовьте POST запрос следующего вида:		Подготовьте POST запрос следующего вида:

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

Merkulov: Новая страница: «Подготовьте POST запрос следующего вида: base URL: https:///communal/client/list/read В '''AUTHORIZATION''' укажите значение access_token согласно: Bearer token : token <значение '''acces_token'''> В '''BODY''' запроса передайте данные в формате JSON согласно структуре. ''Пример JSON:''
2022-03-23T14:23:10Z

Новая страница: «Подготовьте POST запрос следующего вида: base URL: https://<URL-адрес сервера SharePoint>/communal/client/list/read В '''AUTHORIZATION''' укажите значение access_token согласно: Bearer token : token <значение '''acces_token'''> В '''BODY''' запроса передайте данные в формате JSON согласно структуре. ''Пример JSON:'' <synt...»

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

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

В '''AUTHORIZATION''' укажите значение access_token согласно:

Bearer token : token <значение '''acces_token'''>

В '''BODY''' запроса передайте данные в формате JSON согласно структуре.

''Пример JSON:''

<syntaxhighlight lang="JSON">
{
"apartment": "string", // Квартира
"building": "string", // Корпус
"house": "string", // Дом
"name": "string", // ФИО Клиента
"organizationId": <id организации>, // ID организации
"personalAccount": "string", // Номер лицевого счета
"street": "string", // Улица
"town": "string" // Населенный пункт
}
</syntaxhighlight>