Изменения в документации по API

23 ноября 2022 20 208

Внесли корректировки в документацию по API Диадока. Изменения в структуре помогут облегчить работу пользователей.

Раздел «С чего начать»

Переехали две старые страницы:

Появились две новые страницы:

Раздел «Руководство по работе с API» 

Весь раздел «Общее описание возможностей» переименовали в «Руководство по работе с API».

В него перенесли страницы:

  • «Модель данных» из раздела «Общее описание возможностей» на страницу «Как устроен Диадок»;
  • «Структуры данных» из раздела «Техническая документация» на страницу «Передача данных в API»;
  • «Авторизация» из раздела «Техническая документация» на страницу «Авторизация».

Подраздел «Описание сущностей»

В «Описание сущностей» вошли страницы: 

Подраздел «Базовая функциональность»

В «Базовой функциональности» закрепили страницы:

Подраздел «Работа с сущностями API»

В «Работу с сущностями API» перенесли все страницы из раздела «Техническая документация», кроме «Структуры данных» и «Авторизации». О них выше.

Подраздел «Документооборот»

В «Документооборот» переехали все страницы из раздела «Документооборот», кроме страницы GetDocumentTypes.

Подраздел «Примеры»

В «Примеры» отправили все страницы из раздела «Примеры использования».

Разделы, от которых мы отказались

Мы заменили разделы:

  • «Общее описание возможностей»;
  • «Документооборот»;
  • «Примеры использования»;
  • «Техническая документация».

Страницу GetDocumentTypes вынесли из раздела «Документооборот». Дадим на нее ссылки в соответствующих разделах.

Изменения в содержании страниц

Ориентируйтесь на новую структуру документации в дальнейшей работе с API Диадока.


Как вырос роуминг в Диадоке в 2022 году

Диадок активно развивает в сервисе обмен электронными документами с клиентами других операторов. В новости расскажем, каких результатов мы достигли в 2022 и что планируем сделать в 2023 году.