Примеры API запросов - История изменений

Oagapov в 09:56, 9 марта 2025

2025-03-09T09:56:16Z

← Предыдущая версия		Версия от 09:56, 9 марта 2025
Строка 163:		Строка 163:

	Полный перечень объектов и методов API платформы можно найти по [https://vendor.era-platform.ru/docs/era/latest/api/index.html ссылке]		Полный перечень объектов и методов API платформы можно найти по [https://vendor.era-platform.ru/docs/era/latest/api/index.html ссылке]
	~~[[Категория:Разработка приложений]]~~
	[[Категория:Практика]]		[[Категория:Практика]]

Oagapov: Oagapov переименовал страницу REST API в Примеры API запросов без оставления перенаправления

2025-03-08T11:38:59Z

Oagapov переименовал страницу REST API в Примеры API запросов без оставления перенаправления

← Предыдущая версия	Версия от 11:38, 8 марта 2025
(нет различий)

Oagapov в 11:31, 8 марта 2025

2025-03-08T11:31:41Z

← Предыдущая версия		Версия от 11:31, 8 марта 2025
Строка 160:		Строка 160:
	}		}
	}		}


			Полный перечень объектов и методов API платформы можно найти по [https://vendor.era-platform.ru/docs/era/latest/api/index.html ссылке]
	[[Категория:Разработка приложений]]		[[Категория:Разработка приложений]]
	[[Категория:Практика]]		[[Категория:Практика]]

Oagapov в 11:31, 8 марта 2025

2025-03-08T11:31:23Z

← Предыдущая версия		Версия от 11:31, 8 марта 2025
Строка 1:		Строка 1:
	~~Обзор~~ API ~~платформы можно найти на [https://vendor~~.~~era-platform.ru/docs/era/latest/api/index.html ресурсе vendor]~~[[Файл:Настройка канала интеграции.png\|мини\|Настройка канала интеграции]]		В статье указаны некоторые примеры обращений при помощи REST API к платформе.[[Файл:Настройка канала интеграции.png\|мини\|Настройка канала интеграции]]

	== Как сделать первый API запрос ==		== Как сделать первый API запрос ==

Oagapov в 11:26, 8 марта 2025

2025-03-08T11:26:21Z

← Предыдущая версия		Версия от 11:26, 8 марта 2025
Строка 161:		Строка 161:
	}		}
	[[Категория:Разработка приложений]]		[[Категория:Разработка приложений]]
			[[Категория:Практика]]

AZykov в 10:51, 6 января 2025

2025-01-06T10:51:04Z

← Предыдущая версия		Версия от 10:51, 6 января 2025
Строка 1:		Строка 1:
	Обзор API платформы можно найти на [https://vendor.era-platform.ru/docs/era/latest/api/index.html ~~портале~~ vendor][[Файл:Настройка канала интеграции.png\|мини\|Настройка канала интеграции]]		Обзор API платформы можно найти на [https://vendor.era-platform.ru/docs/era/latest/api/index.html ресурсе vendor][[Файл:Настройка канала интеграции.png\|мини\|Настройка канала интеграции]]

	== Как сделать первый API запрос ==		== Как сделать первый API запрос ==

AZykov в 10:49, 6 января 2025

2025-01-06T10:49:03Z

← Предыдущая версия		Версия от 10:49, 6 января 2025
Строка 1:		Строка 1:
	[[Файл:Настройка канала интеграции.png\|мини\|Настройка канала интеграции]]		Обзор API платформы можно найти на [https://vendor.era-platform.ru/docs/era/latest/api/index.html портале vendor][[Файл:Настройка канала интеграции.png\|мини\|Настройка канала интеграции]]

	== Как сделать первый API запрос ==		== Как сделать первый API запрос ==

Oagapov в 16:35, 12 декабря 2024

2024-12-12T16:35:48Z

← Предыдущая версия		Версия от 16:35, 12 декабря 2024
Строка 160:		Строка 160:
	}		}
	}		}
	[[Категория:~~Продуктовый слой~~]]		[[Категория:Разработка приложений]]

Oagapov в 10:25, 11 декабря 2024

2024-12-11T10:25:50Z

Внесённые изменения

Oagapov: Новая страница: «== Как сделать первый API запрос == Создайте токен авторизации в Приложении Настройка — Каналы интеграции (/service/integration_points). Укажите тип Subscriber, назначьте пользователя. Используйте метод авторизации Bearer для выполнения запроса и поле локальный токен. Выпо...»

2024-12-09T16:38:26Z

Новая страница: «== Как сделать первый API запрос == Создайте токен авторизации в Приложении Настройка — Каналы интеграции (/service/integration_points). Укажите тип Subscriber, назначьте пользователя. Используйте метод авторизации Bearer для выполнения запроса и поле локальный токен. Выпо...»

Новая страница

== Как сделать первый API запрос ==
Создайте токен авторизации в Приложении Настройка — Каналы интеграции (/service/integration_points).

Укажите тип Subscriber, назначьте пользователя.

Используйте метод авторизации Bearer для выполнения запроса и поле локальный токен.

Выполните POST запрос. Обратите внимание на кодировку пробела %20

Подробная документация REST API

== Работа с колл-листом через REST API ==
Разберем примеры управления колл-листом на примерах. Создайте канал интеграции для REST API и укажите пользователя.

Получите всё содержимое (в формате JSON) класса GET запросом:
<nowiki>https://{{ERAURL}}/rest/v1/model/callcenter/outbound/SimpleContragents</nowiki>
Получите конкретную запись по id, например e480b13d-0191-d748-ae42-960002bdc633 при помощи GET-запроса:
<nowiki>https://{{ERAURL}}/rest/v1/model/callcenter/outbound/SimpleContragents/e480b13d-0191-d748-ae42-960002bdc633</nowiki>
Получите список записей класса при помощи фильтра. В примере вы получите список контрагентов, ФИО которых содержит подстроку «Бывал» (регистр важен):
<nowiki>https://{{ERAURL}}/rest/v1/model/callcenter/outbound/SimpleContragents?filter=</nowiki>["like",["property","fio"],["const","*Бывал*"]]
Получите список записей из колл-листа по id исходящей кампании
<nowiki>https://{{ERAURL}}/rest/v1/model/callcenter/outbound/SimpleContragents?filter=</nowiki>["==",["property","campaign_id"],["const","12d425a3-a69e-4b83-9527-2d23af2cecb6"]]
''Для построения более сложных фильтров, сортировок и группировок используйте приложение Builder — Sandbox REST API.''

Для добавления записи используйте POST запрос и передайте необходимую JSON структуру записи:
<nowiki>https://{{ERAURL}}/rest/v1/model/callcenter/outbound/SimpleContragents</nowiki>

{ "campaign_id": "c1692593-23e2-410a-bf8f-f3a2c27cd863", "ext": null, "fio": "Никита Леонидович Небывалый", "id": "e6d03318-ad64-4ba8-b8ee-dac91edee5ad", "increment": null, "notes": "Задолженность: 466681 руб.", "personalAgent_id": null, "phoneNumbers": [ { "kind": "mobile", "phoneNumber": "89902355924" } ], "result": null, "scheduledNumber": null, "scheduledTime": null, "scheduledTimeMax": null, "state": null, "timeZone": null, "tryCount": null }
''Обратите внимание, что даже указано поле id, платформа изменит значение на собственное.''

Для полного изменения записи используйте запрос PUT
<nowiki>https://{{ERAURL}}/rest/v1/model/callcenter/outbound/SimpleContragents/e480b13d-0191-d748-ae42-960002bdc633</nowiki>

{ "campaign_id": "c1692593-23e2-410a-bf8f-f3a2c27cd863", "fio": "Никита Леонидович Бывалый", "id": "e480b13d-0191-d748-ae42-960002bdc633", "increment": 266, "notes": "Задолженность: 466681 руб.", "phoneNumbers": [ { "kind": "mobile", "phoneNumber": "89902355924" } ] }
''Обратите внимание, что в этом запросе необходимо передать все поля. Поля, которые не будут указаны, будут иметь пустое значение.''

Для частично изменения записи используйте запрос PATCH.
<nowiki>https://{{ERAURL}}/rest/v1/model/callcenter/outbound/SimpleContragents/e480b13d-0191-d748-ae42-960002bdc633</nowiki>

{ "fio": "Никита Леонидович Небывалый", }
''Обратите внимание, что достаточно передать поля, необходимые к замене. Id записи изменить невозможно.''

Для удаления записи с id = e480b13d-0191-d748-ae42-960002bdc633 используйте DELETE запрос:
<nowiki>https://{{ERAURL}}/rest/v1/model/callcenter/outbound/SimpleContragents/e480b13d-0191-d748-ae42-960002bdc633</nowiki>
Полная документация для управления при помощи REST API.

== Управление исходящей кампанией через REST API ==
Для запуска и остановки исходящей кампании воспользуйтесь POST запросом
[https://{{ERAURL}}/rest/v1/domain/nservices/callcenter.HolderService https://{ERAURL}/rest/v1/domain/nservices/callcenter.HolderService]
Для старта кампании
{ "method":"Campaign_start", "request": { "id": "12d425a3-a69e-4b83-9527-2d23af2cecb6" } }
Для остановки кампании
{ "method":"Campaign_stop", "request": { "id": "12d425a3-a69e-4b83-9527-2d23af2cecb6" } }
Пример:

Получить ID кампании вы можете через REST API запрос списка кампаний (/rest/v1/model/callcenter/outbound/Campaigns) или вывести колонку ИД в интерфейсе приложения «Исходящие кампании».

== Как повторить любой клиентский функционал при помощи API ==
Повторим функцию отправки внутреннего сообщения в канал.

Откройте приложения «Оператор», вкладку «Внутренние чаты». Нажмите F12 и обновите страницу. На вкладке Network найдите сервис ws с типом websocket. Очистите сообщения для удобства. Отправьте сообщение в канал. Найдите событие send, которое отвечает за отправку сообщения.
[ "rest", { "operation":"replace", "classpath":"/rest/v1/model/platform/services/Invocations", "id":"92b4f40e-ddf8-4b4d-aae8-c9d6fb9765c0", "content":{ "id":"92b4f40e-ddf8-4b4d-aae8-c9d6fb9765c0", "timeToLive":600, "from":"315e1a82-9076-4c8a-94ff-d857a7798aae", "to":"im.HolderService", "method":"InnerDialog_sendText", "request":{ "id":"428a8cd0-94a9-48be-806e-ac2c7240f76a", "user_id":"0ce07813-018f-7be9-2969-960002bdc633", "parameters":{ "text":"привет" } } }, "qid":"be8e8315-5b51-49af-bd6b-3626cdac7cc3" } ]
Сообщение содержит все необходимые поля для повтора функционала как изнутри платформы, так и при помощи REST API. Существенные параметры:

"to":"im.HolderService" - микросервис платформы, ответственный за операцию,

"method":"InnerDialog_sendText" - метод микросервиса,

"id":"428a8cd0-94a9-48be-806e-ac2c7240f76a" - id чата или канала,

"user_id":"0ce07813-018f-7be9-2969-960002bdc633" - id пользователя платформы,

"parameters":{"text":"привет"} - передаваемый контент.

1. Способ. Вызов микросервиса из сценария

Воспользуйтесь компонентом SVC или IVR сценария “Вызов микросервиса продуктового слоя”:

Микросервис - im.HolderService,

Метод - InnerDialog_sendText,

Способ задания параметров - произвольный и передайте в качестве параметра текст:
{ "id":"428a8cd0-94a9-48be-806e-ac2c7240f76a", "user_id":"0ce07813-018f-7be9-2969-960002bdc633", "parameters":{ "text":"привет"} }
2. Способ. Вызов при помощи REST API

Выполните POST запрос

[https://{{ERAURL}}/rest/v1/domain/nservices/im.HolderService https://{ERAURL}/rest/v1/domain/nservices/im.HolderService]

Передайте в качестве параметра JSON
{ "method":"InnerDialog_sendText", "request":{ "id":"428a8cd0-94a9-48be-806e-ac2c7240f76a", "user_id":"0ce07813-018f-7be9-2969-960002bdc633", "parameters":{ "text":"привет" } } }
[[Категория:Продуктовый слой]]