Что такое api диадок
API Диадока
Возможности API Диадока
Программный интерфейс
Варианты интеграции
В зависимости от решаемых прикладных задач и от требований к клиентской части можно выбрать наиболее подходящий вид интеграции с API Диадока
HTTP-based — интеграция с произвольными учетными системами
AddInDiadocAPI — интеграция с учетными системами на платформе 1С
HTTP-based — интеграция с произвольными учетными системами
Для интеграции с произвольными учетными системами. Этот уровень интеграции является наиболее общим, и на нем, в частности, обеспечивается платформонезависимость для интеграционных решений.
Вариант подходит для работы с различными учетными системами, написанными на языке C# под платформу.NET и запускающиеся на машинах с ОС Microsoft Windows, или на Java/C++, запускающиеся на машинах под управлением ОС Linux.
Для интеграторов, ведущих разработку в стеке технологий Microsoft, доступна клиентская.NET/COM-библиотека DiadocApi.dll, которая берет на себя работу по преобразованию локальных обращений к свойствам и методам некоторых объектов в соответствующие HTTP-команды API Диадока.
Кроме того, DiadocApi.dll инкапсулирует детали работы с криптографией, так что прикладному разработчику не нужно разбираться с тонкостями обращений к CryptoAPI. Актуальная версия библиотеки DiadocApi.dll вместе с исходниками входит в состав SDK, который доступен для скачивания по ссылке.
SDK для API Диадока доступен для следующих языков: C#, Java и C++, также возможна работа с Диадоком посредством COM-сервисов.
AddInDiadocAPI — интеграция с учетными системами на платформе 1С
Внешняя компонента, предназначенная для интеграции с учетными системами на платформе 1С. Данный способ позволяет максимально быстро решать типовые задачи, возникающие при интеграции 1С-решений с Диадоком. Компонента может запускаться на машинах с ОС Microsoft Windows, не требуя установки каких-либо дополнительных модулей.
Для разработчиков, занимающихся интеграцией Диадока с различными программными продуктами, построенными на платформе 1С, доступен специальный внешний компонент, который позволяет максимально быстро решать типовые задачи, возникающиепри стыковке 1С-решений с Диадоком.
Этот компонент написан на языке C++ и не содержит лишних зависимостей, что позволяет использовать его на любой Windows-системе, не требуя установки каких-либо дополнительных модулей.
API.Диадок
Интеграция посредством API Диадока актуальна для разных учетных систем, не имеющих единого решения, или если уже существующее на текущий момент не устраивает компанию. Благодаря интеграции учетная система получает те функции Диадока, которые необходимы организации по ЭДО.
Программный функционал
Способы создания
интеграционных решений
API Диадок предлагает два эффективных варианта решения поставленных задач по интеграции в области электронного документооборота. Сотрудники нашей компании Контур.Диадок помогут вам определиться с оптимальным в соответствии с вашими потребностями.
Этот способ интеграции считается общим, с его помощью, в частности, гарантируется независимость платформ для интеграционных решений.
Этот способ актуален для использования разных учетных записей, созданных на языке С+ под платформу.NET и инстализирующихся на устройствах с операционной системой Microsoft Windows, а также на Java/C++, которые запускаются на оборудовании с ОС Linux.
Клиентская.NET/COM-библиотека DiadocApi.dll используется интеграторами, которые разрабатывают продукты в стеке технологий Microsoft. Она отвечает за превращение локальных сигналов к физическим характеристикам определенных объектов в специальные HTTP-команды API Диадок.
Помимо этого, она изолирует данные криптографической деятельности, по этой причине прикладной разработчик может не вникать в нюансы пользования CryptoAPI. Текущая версия DiadocApi.dll в комплексе с исходниками внесена в структуру SDK, а его, в свою очередь, можно скачать ниже.
SDK для API Диадока используется для программирования на C+, Java и C++, кроме того, с программой можно работать через COM-сервисы.
Этот внешняя составляющая, главная задача которой состоит в объединении учетных систем на 1С. С помощью этого метода получится избавиться от длительного решения типовых задач, которые появляются при объединении 1С с Диадоком. Составляющая может работать на оборудовании с операционной системой Microsoft Windows. При этом дополнительно устанавливать вспомогательные модули не понадобится.
Специальная внешняя составляющая актуальна для использования разработчиками, которые занимаются объединением Диадока с различными программными решениями, разработанными на платформе 1С. Она дает возможность программистам оперативно находить решения типовых задач, которые появляются при состыковке 1С-программ с Диадоком.
Данная составляющая кодирована на языке программирования C++, не имеет в структуре излишних зависимостей. Это дает возможность внедрять ее на любой системе на базе ОС Microsoft без инстализации дополнительных модульных элементов.
Заполните форму и нажмите «Отправить»
Наш специалист свяжется с вами в ближайшее время!
Порядок работы с API¶
В данном разделе описаны только базовые функции, предоставляемые посредством программного интеграторского веб-интерфейса Диадока для организации документооборота. Дополнительные возможности описаны в соответствующих разделах. Полный список команд API всегда можно посмотреть в технической документации.
Аутентификация¶
Любой сеанс работы клиента API начинается с прохождения процедуры аутентификации, в ходе которой программный клиент от имени пользователя получает авторизационный токен, однозначно идентифицирующий этого пользователя и дающий клиенту право читать и писать в ящики Диадока, к которым данный пользователь имеет доступ.
Пользователь может аутентифицироваться в системе либо по сертификату электронной подписи формата X.509, либо по паре логин/пароль.
В результате аутентификации формируется специальный авторизационный токен, дающий право доступа к Диадоку посредством интеграционного API в течение некоторого интервала времени (порядка нескольких часов).
Полученный авторизационный токен в дальнейшем должен передаваться в качестве параметра во все методы API, выполняющие какие-либо операции в контексте конкретного ящика, чтобы авторизовать доступ пользователя к этому ящику. Кроме того, во все методы API клиент должен передавать так называемый «ключ разработчика», однозначно идентифицирующий автора данного интеграционного решения.
Передача документа¶
Соответственно, набор взаимосвязанных пользовательских и служебных документов (т.е. вся цепочка документооборота, связанная с конкретным набором пользовательских документов, передаваемых через Диадок) образует сообщение (объект Message ).
Каждый документооборот может охватывать либо две организации (в этом случае естественным образом по направлению передачи первого документа в цепочке выделяются организация-отправитель и организация-получатель), либо одну организацию (в случае внутреннего документооборота внутри конкретной организации).
Соответственно, в рамках документооборота между двумя организациями формируются две цепочки: в ящике отправителя и в ящике получателя.
Документы, которые были сформированы и отправлены, отображаются в обеих цепочках. Документы, которые были только сформированы, но не отправлены (см. возможности метода PostMessage ниже), отображаются в соответствующей цепочке (либо только в ящике отправителя, либо только в ящике получателя).
В качестве ящика отправителя клиент может указывать только «свой» ящик, то есть ящик, к которому он может получить доступ при помощи имеющегося у него авторизационного токена.
В результате вызова метода PostMessage формируется новая цепочка документооборота, связывающая ящики отправителя и получателя.
В ящике отправителя информация о сформированной цепочке появляется в момент вызова метода PostMessage (соответственно, формируется событие о появлении документа, информацию о событиях см. ниже).
Информация о новой цепочке документооборота и связанных с ней документах в ящике получателя, вообще говоря, появится с некоторой задержкой, связанной с асинхронной передачей информации из ящика отправителя в ящик получателя.
То есть успешный вызов метода PostMessage гарантирует лишь появление исходящего сообщения в ящике отправителя; в ящике получателя сообщение и соответствующее событие могут появиться с некоторой задержкой.
Дополнение документа¶
Эта структура содержит идентификатор цепочки документооборота, которую следует дополнить новым документом, и идентификатор ящика, с которым эта цепочка связана (если в документооборот вовлечено две организации, то в ящике второй стороны цепочка документооборота также будет обновлена; обновление производится асинхронно).
Клиент должен дополнять цепочку документооборота через «свой» ящик, то есть через тот ящик, к которому у него есть доступ.
Если загружаемый документ имеет большой размер (больше 100Кб), то для загрузки такого документа в Диадок следует пользоваться сервисом «полки документов».
Получение документа¶
Отметим, что структура Message может содержать документы, сформированные в разное время разными организациями (например, в одну такую структуру могут попасть исходящий документ одной организации и подпись к этому документу, поставленная представителем другой организации).
Таким образом, каждый ящик в Диадоке может изменяться лишь одним из двух способов:
То есть вся уже существующая в ящике информация не может быть изменена, она может быть лишь дополнена. Соответственно, все модификации ящика естественным образом упорядочиваются хронологически, и можно говорить о «событиях», связанных с конкретным ящиком:
Диадок API
Функционал электронного документооборота на основе этих методов можно реализовать в любую современную информационную систему (1С, SAP, Oracle, Microsoft Dynamics AX/NAV и др.).
API — программный код, написанный авторами одной системы для того, чтобы авторы других программ могли с помощью этого кода «научить» свои программные продукты взаимодействовать между собой.
С помощью данного метода и/или коннекторов можно реализовать интеграцию с любой учетной системой.
Чтобы начать пользоваться кодом требуется ключ разработчика, распространяющийся платно.
У Диадок есть три вида API:
API Диадока позволяет выполнять все основные операции, что и в веб-интерфейсе:
В зависимости от решаемых прикладных задач и от требований к клиентской части можно выбрать следующие виды интеграции:
Базовым уровнем интеграции с Диадоком является его HTTP-based API. Этот уровень является наиболее общим, и на нем, в частности, обеспечивается платформо-независимость для интеграционных решений.
Кроме того, есть интеграция с криптографией, так что Вам не нужно разбираться с тонкостями обращений к CryptoAPI. Актуальная версия библиотеки вместе с исходниками входит в состав diadoc SDK.
Преимущества интеграции в Вашу систему:
Дополнительные функции
Ниже дан краткий обзор дополнительных функций.
Отправка заявления участника ЭДО
При помощи метода SendFnsRegistrationMessage можно отправить заявление участника ЭДО.
Поиск контрагентов
Метод GetOrganizationsByInnKpp позволяет искать в Диадоке ящики по ИНН и КПП организаций, которым они принадлежат.
При помощи метода GetOrganization можно по идентификатору организации узнать различные справочные данные, заведенные в Диадок, такие как ИНН, КПП, название, а также получить список ее ящиков.
Черновики
Диадок позволяет помещать в «свой» ящик еще не подписанные документы без их немедленной отправки контрагентам.
Это может быть полезно, когда подготовкой документов занимается один человек, а правом подписи и отправки обладает другой.
Подготовка печатных форм
Для документов, передаваемых через Диадок, в формализованном не человекочитаемом виде, предусмотрена возможность получения их печатных форм.
Фильтрация списка документов
При помощи метода GetDocuments, можно быстро получать информацию о документах (например, о счетах-фактурах) в своем ящике, задавая различные критерии фильтрации документов.
Кроме того, есть возможность получить всю метаинформацию об отдельном документе, зная его идентификатор. Для этого предназначен метод GetDocument.
Вход в систему
Любой сеанс работы начинается с прохождения процедуры аутентификации, в ходе которой программный клиент от имени пользователя получает авторизационный токен, однозначно идентифицирующий этого пользователя и дающий клиенту право читать и писать в ящики Диадока, к которым данный пользователь имеет доступ.
Пользователь может аутентифицироваться в системе либо по сертификату электронной подписи формата X.509, либо по паре логин/пароль.
Что нужно для интеграции с Diadoc API:
1. Заполнить заявку, чтобы получить ключ разработчика и сертификат тестовой квалифицированной электронной подписи;
2. Оплатить счет на ключ API;
3. Оплатить услуги по консультации, если необходимо.
В случае возникновения вопросов обращайтесь по телефону или ссылке «Получить консультацию».
Порядок работы с API¶
В данном разделе описаны только базовые функции, предоставляемые посредством программного интеграторского веб-интерфейса Диадока для организации документооборота. Дополнительные возможности описаны в соответствующих разделах. Полный список команд API всегда можно посмотреть в технической документации.
Аутентификация¶
Любой сеанс работы клиента API начинается с прохождения процедуры аутентификации, в ходе которой программный клиент от имени пользователя получает авторизационный токен, однозначно идентифицирующий этого пользователя и дающий клиенту право читать и писать в ящики Диадока, к которым данный пользователь имеет доступ.
Пользователь может аутентифицироваться в системе либо по сертификату электронной подписи формата X.509, либо по паре логин/пароль.
В результате аутентификации формируется специальный авторизационный токен, дающий право доступа к Диадоку посредством интеграционного API в течение некоторого интервала времени (порядка нескольких часов).
Полученный авторизационный токен в дальнейшем должен передаваться в качестве параметра во все методы API, выполняющие какие-либо операции в контексте конкретного ящика, чтобы авторизовать доступ пользователя к этому ящику. Кроме того, во все методы API клиент должен передавать так называемый «ключ разработчика», однозначно идентифицирующий автора данного интеграционного решения.
Передача документа¶
Соответственно, набор взаимосвязанных пользовательских и служебных документов (т.е. вся цепочка документооборота, связанная с конкретным набором пользовательских документов, передаваемых через Диадок) образует сообщение (объект Message ).
Каждый документооборот может охватывать либо две организации (в этом случае естественным образом по направлению передачи первого документа в цепочке выделяются организация-отправитель и организация-получатель), либо одну организацию (в случае внутреннего документооборота внутри конкретной организации).
Соответственно, в рамках документооборота между двумя организациями формируются две цепочки: в ящике отправителя и в ящике получателя.
Документы, которые были сформированы и отправлены, отображаются в обеих цепочках. Документы, которые были только сформированы, но не отправлены (см. возможности метода PostMessage ниже), отображаются в соответствующей цепочке (либо только в ящике отправителя, либо только в ящике получателя).
В качестве ящика отправителя клиент может указывать только «свой» ящик, то есть ящик, к которому он может получить доступ при помощи имеющегося у него авторизационного токена.
В результате вызова метода PostMessage формируется новая цепочка документооборота, связывающая ящики отправителя и получателя.
В ящике отправителя информация о сформированной цепочке появляется в момент вызова метода PostMessage (соответственно, формируется событие о появлении документа, информацию о событиях см. ниже).
Информация о новой цепочке документооборота и связанных с ней документах в ящике получателя, вообще говоря, появится с некоторой задержкой, связанной с асинхронной передачей информации из ящика отправителя в ящик получателя.
То есть успешный вызов метода PostMessage гарантирует лишь появление исходящего сообщения в ящике отправителя; в ящике получателя сообщение и соответствующее событие могут появиться с некоторой задержкой.
Дополнение документа¶
Эта структура содержит идентификатор цепочки документооборота, которую следует дополнить новым документом, и идентификатор ящика, с которым эта цепочка связана (если в документооборот вовлечено две организации, то в ящике второй стороны цепочка документооборота также будет обновлена; обновление производится асинхронно).
Клиент должен дополнять цепочку документооборота через «свой» ящик, то есть через тот ящик, к которому у него есть доступ.
Если загружаемый документ имеет большой размер (больше 100Кб), то для загрузки такого документа в Диадок следует пользоваться сервисом «полки документов».
Получение документа¶
Отметим, что структура Message может содержать документы, сформированные в разное время разными организациями (например, в одну такую структуру могут попасть исходящий документ одной организации и подпись к этому документу, поставленная представителем другой организации).
Таким образом, каждый ящик в Диадоке может изменяться лишь одним из двух способов:
То есть вся уже существующая в ящике информация не может быть изменена, она может быть лишь дополнена. Соответственно, все модификации ящика естественным образом упорядочиваются хронологически, и можно говорить о «событиях», связанных с конкретным ящиком: