Внесли корректировки в документацию по API Диадока. Изменения в структуре помогут облегчить работу пользователей.
Раздел «С чего начать»
Переехали две старые страницы:
- «Возможности для интеграции» на страницу «Варианты интеграции»;
- «Обзор возможностей API» из раздела «Общее описание возможностей» — на страницу «Возможности API».
Появились две новые страницы:
Раздел «Руководство по работе с API»
Весь раздел «Общее описание возможностей» переименовали в «Руководство по работе с API».
В него перенесли страницы:
- «Модель данных» из раздела «Общее описание возможностей» на страницу «Как устроен Диадок»;
- «Структуры данных» из раздела «Техническая документация» на страницу «Передача данных в API»;
- «Авторизация» из раздела «Техническая документация» на страницу «Авторизация».
Подраздел «Описание сущностей»
В «Описание сущностей» вошли страницы:
- «Ящик»;
- «Сообщение»;
- «Сущность сообщения»;
- «Черновик»;
- «Тег».
Подраздел «Базовая функциональность»
В «Базовой функциональности» закрепили страницы:
- «Порядок работы с API» на странице «Работа с документами»;
- «Управление списком активных контрагентов» на странице «Работа с контрагентами»;
- «Дополнительные функции API» на странице «Другие функции».
Подраздел «Работа с сущностями API»
В «Работу с сущностями API» перенесли все страницы из раздела «Техническая документация», кроме «Структуры данных» и «Авторизации». О них выше.
Подраздел «Документооборот»
В «Документооборот» переехали все страницы из раздела «Документооборот», кроме страницы GetDocumentTypes.
Подраздел «Примеры»
В «Примеры» отправили все страницы из раздела «Примеры использования».
Разделы, от которых мы отказались
Мы заменили разделы:
- «Общее описание возможностей»;
- «Документооборот»;
- «Примеры использования»;
- «Техническая документация».
Страницу GetDocumentTypes вынесли из раздела «Документооборот». Дадим на нее ссылки в соответствующих разделах.
Изменения в содержании страниц
- Описание возможностей перенесли с главной страницы на страницу «Возможности API».
- Со страницы «Дополнительные функции API» удалили описание черновика. Выделили в отдельную страницу «Черновик».
Ориентируйтесь на новую структуру документации в дальнейшей работе с API Диадока.