Обмен 1С и Platform

ExchangeChangesFrom1C

Содержит описание набора методов web-сервиса "ExchangeChangesFrom1C", предназначенные для получения, проверки и отправки данных из 1С на Platform.

ExchangeChangesFrom1C

Проверить доступ к web-сервису Ping

Метод Ping позволит проверить доступ к WEB-сервису 1С для вашего ресурса.

Авторизация

Authorizations:

 HTTP: Basic Auth

Логин: User1

Пароль: **********

Примеры кода

Как использовать пример

http://<имя веб сервера>/<имя базы>/hs/ExchangeChangesFrom1C/ping
Имя параметра Описание
<имя веб сервера> Адрес базы данных, к WEB-сервису которой мы обращаемся.
<имя базы> Имя базы данных к которой обращаемся.

Пример запроса

http://web1c.noboring-finance.ru/unf_sandbox/hs/ExchangeChangesFrom1C/ping

Обработка ответа

HTTP-статус: 200

It's successful

Доступ к WEB-сервису получен.

Обработка ошибок

HTTP-статус: 401
Unauthorized

Неверные учетные данные. Введите корректные доступы к системе.

HTTP-статус: 403

Недостаточно прав для использования ресурса с данным HTTP методом

Означает что у пользователя нет прав для работы с выбранным WEB-сервисом. Для предоставления такого доступа рекомендуется пользователю присвоить группу доступа в 1С "(MXSP) Доступ к WEB-сервису для Platform" (см. рис. 1).

image.png

Рисунок 1 - Группа доступа для использования WEB-сервиса.

ExchangeChangesFrom1C

Получить измененные данные из 1С GetChangedData

Метод GetChangedData позволяет получить массив именных в 1С объектов.

Авторизация

Authorizations:

 HTTP: Basic Auth

Логин: User1

Пароль: **********

Параметры метода

Название

тип

 Описание
stop
integer

Параметр используется для управления постраничной навигацией.

Размер страницы результатов задается пользователем. В случае отсутствия параметра в запросе, возвращает все страницы в одном запросе.

Примеры кода

Как использовать пример

http://web1c.noboring-finance.ru/unf_sandbox/hs/ExchangeChangesFrom1C/get/changed/data?stop=5

Обработка ответа

HTTP-статус: 200

{
    "Value": [
        {
            "Ref_Key": "0678427d-e399-11ef-8682-3cecefa65c6f",
            "Object_Type": "Document_АктВыполненныхРабот",
            "DeletionMark": false
        },
        {
            "Ref_Key": "21b20b04-e399-11ef-8682-3cecefa65c6f",
            "Object_Type": "Document_АктВыполненныхРабот",
            "DeletionMark": false
        },
        {
            "Ref_Key": "5a882007-e399-11ef-8682-3cecefa65c6f",
            "Object_Type": "Document_АктВыполненныхРабот",
            "DeletionMark": false
        },
        {
            "Ref_Key": "78e4af01-e399-11ef-8682-3cecefa65c6f",
            "Object_Type": "Document_АктВыполненныхРабот",
            "DeletionMark": false
        },
        {
            "Ref_Key": "8f28d433-e399-11ef-8682-3cecefa65c6f",
            "Object_Type": "Document_АктВыполненныхРабот",
            "DeletionMark": false
        }
    ],
    "PackageNumber": 1,
    "Amount": 5
}

Возвращаемые данные

Название

тип

 Описание
Value
array

Корневой элемент ответа. Содержит массив из объектов, содержащих информацию об измененных объектах.

Массив объектов, вида:

 

{
 "Ref_Key": "000dd874-dfc7-11ef-8682-3cecefa65c6f",
 "Object_Type": "Document_АктВыполненныхРабот",
 "DeletionMark": false
}

где

  • Ref_Key - Уникальный идентификатор объекта
  • Object_Type - тип объекта
  • DeletionMark - статус документа (содержит true если объект помечен на удаление)

PackageNumber

integer

 Номер сообщения отправки данных.

Amount

integer

 Общее количество переданных элементов.

Обработка ошибок

HTTP-статус: 400
{
    "Error": "-",
    "Error_Description": "Failed to convert the value of the parameter 'stop' to a number"
}

Название

тип

 Описание

Error

string

 Строковый код ошибки. Состоит из цифр.

Error_Description

string

 Текстовое описание ошибки. 

Возможные коды ошибок

Код Описание Значение
101 Invalid value for the parameter 'stop' in the request Неверно передано значение параметра в запросе.
102 Failed to convert the value of the parameter 'stop' to a number Ошибка преобразования переданного параметра в число.

ExchangeChangesFrom1C

Передать результат обработки данных DataReceived

Метод DataReceived позволяет сообщить 1С о тех наборах данных которые были обработаны сервисом.

Авторизация

Authorizations:

 HTTP: Basic Auth

Логин: User1

Пароль: **********

Параметры метода

Название

тип

 Описание
PackageNumbers
array

Содержит массив номеров сообщений полученных методом GetChangedData. Номер сообщения содержится в обязательном параметре "PackageNumber". Параметр обязателен при отправке сообщения о получении данных.

Примеры кода

Как использовать пример

http://web1c.noboring-finance.ru/unf_sandbox/hs/ExchangeChangesFrom1C/data/received

Обработка ответа

HTTP-статус: 200
{
    "Result": true
}

Возвращаемые данные

Название

тип

 Описание
Result
boolean
 Корневой элемент ответа, содержит true  в случае успеха.

Обработка ошибок

HTTP-статус: 400
{
    "Error": "-",
    "Error_Description": "Invalid values for parameter {PackageNumbers}"
}

Название

тип

 Описание

Error

string

 Строковый код ошибки. Состоит из цифр.

Error_Description

string

 Текстовое описание ошибки. 

Возможные коды ошибок

Код Описание Значение
201 An empty array was passed in parameter {PackageNumbers} Передан пустой массив значений.
202 Invalid values for parameter {PackageNumbers} Передано неверное значение в параметр "PackageNumbers".
203 Could not find value for parameter {PackageNumbers} Значение для параметра "PackageNumbers" отсутствует в переданных данных.
204 - Внутренняя ошибка сервера.
205 Parameter 'PackageNumbers' must be array Переданный параметр не является массивом.