Page tree
Skip to end of metadata
Go to start of metadata

Вся информация перенесена в WS EDI 2.0




Техническая спецификация EDI Service v.2.0

Аннотация: Описание методов EDI сервиса - обмена электронными документами посредством центра обработки данных CФЕРА EDI с помощью SOAP протокола.

Содержание документа


1. Общая информация
2. Описание методов
2.1 Relationships
2.2 Listmb
2.3 Listpb
2.4 Receive
2.5 Send
2.6 Docstatus
2.7 Коды ошибок

Общая информация

Веб сервис для работы с документами системы электронного документооборота CФЕРА EDI.
Основан на протоколе SOAP 1.1
Сервис содержит 6 методов доступные для пользователя:
-Relationships;
-ListMB;
-ListPB;
-Receive;
-Send;
-DocumentStatus.
Ссылка на WSDL

Описание методов

2.1 Relationships

Основной метод, возвращает список настроек для обмена с партнерами, каждая настройка содержит информацию о типе документа, стандарте, версии, идентификаторе партнера и т. д.
https://edi-ws.esphere.ru/relationships
Аргументы вызова:

  • Name - (строка) - Ваше имя пользователя в системе CФЕРА EDI
  • Password - (строка) - Ваш секретный пароль

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:edi="http://edi-express.esphere.ru/">
<soapenv:Header/>
<soapenv:Body>
<edi:RelationsInput>
<edi:Name>Post3</edi:Name>
<edi:Password>Post3</edi:Password>
</edi:RelationsInput>
</soapenv:Body>
</soapenv:Envelope>

Атрибуты ответа:

  • Res - в случае успешного выполнения равен 1, отрицательные значения этого поля - см. Коды ошибок
  • relation-id - Идентификатор настройки с партнером по обмену. Это идентификатор используется в дальнейшей работе по этой взаимосвязи
  • direction - Направление обмена (IN\OUT). В случае с IN значит, что партнер вам присылает документы (входящие); OUT- вы отправляете документы партнёру.
  • partner-iln - Идентификатор Вашего партнера по обмену
  • document-version - Версия формата документов
  • document-type - Код типа документа CФЕРА EDI.(ORDERS, ORDRSP, INVOIC...)
  • document_type-id - Внутренний идентификатор типа (не используется)
  • document-test - (Флаг документа (тестовый\продуктивный) P - PROD, T-TEST)
  • document-standard - Стандарт документа
  • description - Описание взаимосвязи

Атрибуты ответа:

  • Res - в случае успешного выполнения равен 1, отрицательные значения этого поля Коды ошибок
  • relation-id - Идентификатор настройки с партнером по обмену. Это идентификатор используется в дальнейшей работе по этой взаимосвязи
  • direction - Направление обмена (IN\OUT). В случае с IN значит, что партнер вам присылает документы (входящие); OUT- вы отправляете документы партнёру.
  • partner-iln - Идентификатор Вашего партнера по обмену
  • document-version - Версия формата документов
  • document-type - Код типа документа CФЕРА EDI (ORDERS, ORDRSP, INVOIC...)
  • document_type-id - Внутренний идентификатор типа (не используется)
  • document-test - (Флаг документа (тестовый\продуктивный) P - PROD, T-TEST)
  • document-standard - Стандарт документа
  • description - Описание взаимосвязи

Пример ответа:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body> <ns2:RelationsResponse xmlns:ns2="http://edi-express.esphere.ru/">
<ns2:Res>1</ns2:Res>
<ns2:Cnt>
<ns2:relation-response>
<ns2:relation>
<ns2:relation-id>3516105023155</ns2:relation-id>
<ns2:direction>OUT</ns2:direction>
<ns2:partner-name>Кировский</ns2:partner-name>
<ns2:partner-iln>4607014139991</ns2:partner-iln>
<ns2:document-version>EANCOM 1.0</ns2:document-version>
<ns2:document-type>ORDRSP</ns2:document-type>
<ns2:document-type-id>2</ns2:document-type-id>
<ns2:document-test>P</ns2:document-test>
<ns2:document-standard>EANCOM</ns2:document-standard>
<ns2:description>Ответ на заказ</ns2:description>
</ns2:relation>


2.2 Listmb

Метод получения списка входящих документов.
https://edi-ws.esphere.ru/listmb
Аргументы вызова:

  • Name - (строка) - Ваше имя пользователя в системе CФЕРА EDI.
  • Password - (строка) - Ваш секретный пароль.
  • RelationId - (строка) - Идентификатор входящей (direction=IN) взаимосвязи Relationships
  • DocumentStatus - (перечисление) N-NEW, R-READ, A-ALL.
  • DocDateFrom - (Дата) опционально значение фильтра дата документа от. Формат гггг-мм-дд.
  • DocDateTo - (Дата) опционально значение фильтра дата документа до. Формат гггг-мм-дд.
  • DateFrom - (Дата) опционально значение фильтра дата получения документа (обработки) от. Формат гггг-мм-дд.
  • DateTo - (Дата) опционально значение фильтра дата получения документа (обработки) до. Формат гггг-мм-дд.
  • ItemFrom - опционально индекс первого элемента списка начиная от 0
  • PageSize - опционально размер списка

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:edi="http://edi-express.esphere.ru/">
<soapenv:Header/>
<soapenv:Body>
<edi:ListMBInput>
<edi:Name>Post3</edi:Name>
<edi:Password>Post3</edi:Password>
<edi:RelationId>7489749025151</edi:RelationId>
<edi:DocumentStatus>A,N</edi:DocumentStatus>
<!-Optional:->
<edi:DateFrom>2015-08-25</edi:DateFrom>
<!-Optional:->
<edi:DateTo>2015-08-30</edi:DateTo>
<!-Optional:->
<edi:ItemFrom>0</edi:ItemFrom>
<!-Optional:->
<edi:PageSize>100</edi:PageSize> </edi:ListMBInput>
</soapenv:Body>
</soapenv:Envelope>


Атрибуты ответа:

  • Res - в случае успешного выполнения равен 1, отрицательные значения этого поля - см. Коды ошибок
  • tracking-id - Идентификатор документа в CФЕРА EDI
  • partner-iln - Идентификатор Вашего партнера по обмену
  • document-type - Код типа документа CФЕРА EDI (ORDERS, ORDRSP, INVOIC...)
  • document-number - Номер документа
  • document-date - Дата документа.
  • receive_date - Дата получения (обработки) документа
  • document-status - Статус документа

Пример ответа:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body> <ns2:ListMBResponse xmlns:ns2="http://edi-express.esphere.ru/">
<ns2:Res>1</ns2:Res>
<ns2:Cnt>
<ns2:mailbox-response>
<ns2:document-info>
<ns2:tracking-id>6060741</ns2:tracking-id>
<ns2:partner-iln>9911111111111</ns2:partner-iln>
<ns2:document-type>ORDERS</ns2:document-type>
<ns2:document-number>Г100-05800</ns2:document-number>
<ns2:document-date>2015-08-29+04:00</ns2:document-date>
<ns2:recieve_date>2015-08-29+04:00</ns2:recieve_date>
<ns2:document-status>N</ns2:document-status>
</ns2:document-info>
</ns2:mailbox-response>
</ns2:Cnt>
</ns2:ListMBResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>


2.3 Listpb

Метод получения списка исходящих документов
https://edi-ws.esphere.ru/listpb
Аргументы вызова:

  • Name - (строка) - Ваше имя пользователя в системе CФЕРА EDI
  • Password - (строка) - Ваш секретный пароль
  • RelationId - (строка) - Идентификатор исходящей (direction=OUT) взаимосвязи Relationships
  • DocumentStatus - (перечисление через запятую) N-NEW, R-READ, A-ALL, P-PROCESSED, E-ERROR.
  • TrackingId - (строка) - id документа в БД
  • DateFrom - (дата) опционально Фильтр по дате. Формат гггг-мм-дд
  • DateTo - (дата) опционально Фильтр по дате. Формат гггг-мм-дд
  • ItemFrom - опционально индекс первого элемента списка начиная от 0
  • PageSize - опционально размер списка

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:edi="http://edi-express.esphere.ru/">
<soapenv:Header/>
<soapenv:Body>
<edi:ListPBInput>
<edi:Name>991</edi:Name>
<edi:Password>test</edi:Password>
<edi:RelationId>7489749025151</edi:RelationId>
<edi:DocumentStatus>N,P</edi:DocumentStatus>
<!-Optional:->
<edi:TrackingId>81466466</edi:DocumentStatus>
<!-Optional:->
<edi:DateFrom>2018-02-02</edi:DateFrom>
<!-Optional:->
<edi:DateTo>2018-02-20</edi:DateTo>
<!-Optional:->
<edi:ItemFrom>0</edi:ItemFrom>
<!-Optional:->
<edi:PageSize>100</edi:PageSize>
</edi:ListPBInput>
</soapenv:Body>
</soapenv:Envelope>


Атрибуты ответа:

  • Res - в случае успешного выполнения равен 1, отрицательные значения этого поля - см. Коды ошибок
  • tracking-id - Идентификатор документа в CФЕРА EDI
  • partner-iln - Идентификатор Вашего партнера по обмену
  • document-type - Код типа документа CФЕРА EDI (ORDERS, ORDRSP, INVOIC...)
  • document-number - Номер документа
  • document-date - Дата документа
  • submission-date - Дата отправки
  • document-status-description - Описание статуса документа
  • document-status - Статус документа

Пример ответа:



<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:edi="http://edi-express.esphere.ru/">
<soapenv:Header/>
<soapenv:Body>
<ns2:ListPBResponse xmlns:ns2="http://edi-express.esphere.ru/">
<ns2:Res>1</ns2:Res>
<ns2:Cnt>
<ns2:document-status-response>
<ns2:document-status-item>
<ns2:tracking-id>20169744</ns2:tracking-id>
<ns2:partner-iln>9111111111111</ns2:partner-iln>
<ns2:document-type>PRICAT</ns2:document-type>
<ns2:document-number>239_avr_web</ns2:document-number>
<ns2:document-date>2018-02-21T10:21:00+03:00</ns2:document-number>
<ns2:submission-date>2016-02-12 12:31:48.0</ns2:submission-date>
<ns2:document-status-description>Не прочитан получателем</ns2:document-status-description>
<ns2:document-status>A</ns2:document-status>  

</ns2:document-status-item>
</ns2:document-status-response>
</ns2:Cnt>
</ns2:ListPBResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

 


2.4 Receive

Метод получения содержимого документа
https://edi-ws.esphere.ru/receive
Аргументы вызова

  • Name - (строка) - Ваше имя пользователя в системе CФЕРА EDI
  • Password - (строка) - Ваш секретный пароль
  • RelationId - (строка) - Идентификатор входящей (direction=IN) взаимосвязи Relationships
  • TrackingId - (строка) - Идентификатор документа в системе
  • DocumentStatus - (перечисление) N-NEW, R-READ, A-ALL.

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:edi="http://edi-express.esphere.ru/">
<soapenv:Header/>
<soapenv:Body>
<edi:ReceiveInput>
<edi:Name>Post3</edi:Name>
<edi:Password>Post3</edi:Password>
<edi:RelationId>262535161314515</edi:RelationId>
<edi:TrackingId>6059591</edi:TrackingId>
<edi:DocumentStatus>A</edi:DocumentStatus>
</edi:ReceiveInput>
</soapenv:Body>
</soapenv:Envelope>


Атрибуты ответа.

  • Res - в случае успешного выполнения равен 1, отрицательные значения этого поля Коды ошибок
  • Cnt - (байты) - передача содержимого файла с помощью xsd:base64Binary

Пример ответа:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns2:ReceiveResponse xmlns:ns2="http://edi-express.esphere.ru/">
<ns2:Res>1</ns2:Res>
<ns2:Cnt><!-- BASE64 FILE CONTENT DATA --></ns2:Cnt>
</ns2:ReceiveResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>


2.5 Send

Метод для отправки документа
https://edi-ws.esphere.ru/send
Аргументы вызова

  • Name - (строка) - Ваше имя пользователя в системе CФЕРА EDI
  • Password - (строка) - Ваш секретный пароль
  • RelationId - (строка) - Идентификатор исходящей (direction=OUT) взаимосвязи Relationships
  • DocumentContent - (байты) - Содержимое файла документа для отправки партнеру. См. (xsd:base64). Для преобразования в строку base64 можно использовать декодер: http://www.motobit.com/util/base64-decoder-encoder.asp. После преобразования необходимо убрать из документа пробелы и прочие разделители.

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:edi="http://edi-express.esphere.ru/">
<soapenv:Header/>
<soapenv:Body>
<edi:SendInput>
<edi:Name>Post3</edi:Name>
<edi:Password>Post3</edi:Password>
<edi:RelationId>3516167423131</edi:RelationId>
<edi:DocumentContent><!-- BASE64 FILE CONTENT DATA --></edi:DocumentContent>
</edi:SendInput>
</soapenv:Body>
</soapenv:Envelope>


Атрибуты ответа.

  • Res - в случае успешного выполнения равен 1, отрицательные значения этого поля - см. Коды ошибок
  • Cnt - (строка) - идентификатор загруженного файла.

Пример ответа:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns2:SendResponse xmlns:ns2="http://edi-express.esphere.ru/">
<ns2:Res>1</ns2:Res>
<ns2:Cnt>11822582</ns2:Cnt>
</ns2:SendResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>


2.6 Docstatus

Метод для изменения статуса документа
https://edi-ws.esphere.ru/doc-status
Аргументы вызова

  • Name - (строка) - Ваше имя пользователя в системе CФЕРА EDI
  • Password - (строка) - Ваш секретный пароль
  • Status - (строка) - Идентификатор статуса (возможные значения: "N" - новый, "R" - прочитано)
  • TrackingId - (строка) - Id документа, которому требуется изменить статус

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:edi="http://edi-express.esphere.ru/">
<soapenv:Header/>
<soapenv:Body>
<edi:DocStatusInput>
<edi:Name>Post3</edi:Name>
<edi:Password>Post3</edi:Password>
<edi:Status>R</edi:Status>
<edi:TrackingId>1544</edi:TrackingId>
</edi:DocStatusInput>
</soapenv:Body>
</soapenv:Envelope>


Атрибуты ответа.

  • Res - в случае успешного выполнения равен 1, отрицательные значения этого поля - см. Коды ошибок

Пример ответа:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns2:DocStatusResponse xmlns:ns2="http://edi-express.esphere.ru/">
<ns2:Res>1</ns2:Res>
</ns2:DocStatusResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>


2.7 Коды ошибок

Errors:

Код ошибки

Содержание ошибки

-1

Неверный логин\пароль

-2

Не указаны обязательные параметры вызова

-5

Не настроена карта трансляций форматов отличных от EANCOM/Ошибка трансформации

-6

Не правильно указан идентификатор входящей взаимосвязи

-7

Не правильно указан идентификатор исходящей взаимосвязи

-8

Документ не отправлен

-500

Внутренняя ошибка сервиса


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:edi="http://edi-express.esphere.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <edi:ListPBInput>
         <edi:Name>991</edi:Name>
         <edi:Password>test</edi:Password>
         <edi:RelationId>7489749025151</edi:RelationId>
         <edi:DocumentStatus>N,P</edi:DocumentStatus>
         <!--Optional:-->
         <edi:TrackingId>81466466</edi:TrackingId>
         <!--Optional:-->
         <edi:DateFrom>2018-02-15</edi:DateFrom>
         <!--Optional:-->
         <edi:DateTo>2018-02-21</edi:DateTo>
         <!--Optional:-->
         <edi:ItemFrom>0</edi:ItemFrom>
         <!--Optional:-->
         <edi:PageSize>100</edi:PageSize>
      </edi:ListPBInput>
   </soapenv:Body>
</soapenv:Envelope>


  • No labels