Документация API

POST /register - создаёт аккаунт организации

Обязательные заголовки:

Параметры запроса:

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

{
    "username":"company@company.ru", 
    "password":"abc123", 
    "password2":"abc123"
}

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

{
    "status": "Success", 
    "message": "Registered successfully."
}

После создания основного аккаунта организации, можно добавлять пользователей с помощью АПИ POST /user. В случае же, если требуется разрешить пользователям самостоятельно регистрироваться с привязкой к данной организации (например, пользователям Вашего мобильного приложения), то необходимо разрешить это в настройках аккаунта, установив параметр allowSelfRegistration: true (подробнее об изменении настроек см. раздел Настройки).

При установленном параметре allowSelfRegistration: true, пользователь может зарегстрироваться указав id организации, к которой он присоединяется:

POST /register - создаёт аккаунт организации

Обязательные заголовки:

Параметры запроса:

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

{
    "username":"company@company.ru", 
    "password":"abc123", 
    "password2":"abc123",
    "organizationId":"1dfece35-e353-467c-8984-54896648fa9d"
}

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

{
    "status": "Success", 
    "message": "Registered successfully."
}

После создания аккаунта на почту, указанную в качестве username, придёт письмо со ссылкой для подтверждения адреса e-mail вот такого вида: https://azdoc.online/confirm/msCq5y1Qptvg91ssY6SDVa70itNaaMa5KQa9C9ao4BbwYDH0RP
Необходимо перейти по ссылке, чтобы подтвердить аккаунт, иначе, через 24 часа он будет заблокирован.

POST /pass/change - изменяет текущий пароль на новый.

Обязательные заголовки:

Параметры запроса:

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

{
    "username":"company@company.ru", 
    "currentPassword": "abc123"
    "password":"xyz123", 
    "password2":"xyz123"
}

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

{
    "status": "Success", 
    "message": "Changed successfully."
}

Восстановление пароля осуществляется в 2 шага:

• Вызов АПИ для отправки кода сброса на e-mail
• Вызов АПИ для установки нового пароля

POST /code/send - высылает код сброса на e-mail

Обязательные заголовки:

Параметры запроса:

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

{
    "username":"company@company.ru"
}

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

{
    "status": "Sent", 
}

POST /pass/set - устанавливает новый пароль.

Обязательные заголовки:

Параметры запроса:

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

{
    "username":"company@company.ru", 
    "code": "351665"
    "password":"xyz123", 
    "password2":"xyz123"
}

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

{
    "status": "Success", 
    "message": "Password set successfully."
}

Для аутентификации запросов используются токены: Access Token для доступа и Refresh Token для периодического обновления Access Token. Для чего в системе нужны эти два токена можно почитать в статье на Хабре "Зачем нужен Refresh Token, если есть Access Token?"

Access Token указывается в заголовке Authorization после ключевого слова Bearer.

Пример запроса c Access Token:

{
    "username":"company@company.ru", 
    "group":"reader"
}

Обязательные заголовки:

Параметры запроса:

• access_token - Access Token, который используется во всех запросах, требующих аутентификацию
• expires_on - timestamp, время истечения Access Тоken, равное текущему времени + 30 минут
• refresh_token - Refresh Token, время жизни - 30 дней, используется однократно для обновления Access Token, после чего становится недействителен

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

{
    "username":"company@company.ru", 
    "password":"xyz123"
}

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

{
    "access_token": "FnxFbhGRuBdGx7yYVYxatzd72O0nMfXugf2PazKv0RLll9OaAZ",
    "expires_on": 1623220341259,
    "refresh_token": "d1E71Ow8SmVVBadV1b89vlkioupjMPHrXflyGM8QpeeDDfRixV"
}

Обязательные заголовки:

Параметры запроса:

• access_token - Access Token, который используется во всех запросах, требующих аутентификацию
• expires_on - timestamp, время истечения Access Тоken, равное текущему времени + 30 минут
• refresh_token - Refresh Token, время жизни - 30 дней, используется однократно для обновления Access Token, после чего становится недействителен

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

{
    "refresh_token":"d1E71Ow8SmVVBadV1b89vlkioupjMPHrXflyGM8QpeeDDfRixV"
}

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

{
    "access_token": "FnxFbhGRuBdGx7yYVYxatzd72O0nMfXugf2PazKv0RLll9OaAZ",
    "expires_on": 1623220341259,
    "refresh_token": "d1E71Ow8SmVVBadV1b89vlkioupjMPHrXflyGM8QpeeDDfRixV"
}

POST /user - добавляет нового пользователя. Для добавления пользователей нужно обладать правами уровня admin.

Обязательные заголовки:

Параметры запроса:

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

{
    "username":"new.user@company.ru", 
    "group":"admin"
}

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

{
    "status": "Success",
    "message": "Created successfully.",
    "id": "447e6810-5047-47c5-b4dc-740132ede06c"
}

GET /user/{id} - чтение данных пользователя. Для использования данного АПИ нужно обладать правами уровня admin. Чтобы получить данные о собственном аккаунте используется АПИ GET /profile, который доступен всем авторизованным пользователям.

Обязательные заголовки:

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

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

{
    "id": "447e6810-5047-47c5-b4dc-740132ede06c",
    "email": "ivan.pavlov@company.ru",
    "firstName": "Ivan",
    "lastName": "Pavlov",
    "group": "admin",
    "active": true
}

GET /user/list - получение списка пользователей. Для использования данного АПИ нужно обладать правами уровня admin.

Обязательные заголовки:

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

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

[
    {
        "id": "85f1e232-9825-4fd4-b272-5f28cd20f186",
        "email": "super.user@company.ru",
        "firstName": "Иван",
        "lastName": "Павлов",
        "group": "admin",
        "active": true
    },
    {
        "id": "ffe8df10-06cd-43b1-95da-739fa806a9d4",
        "email": "second.user@company.ru",
        "firstName": "Александр",
        "lastName": "Попов",
        "group": "author",
        "active": true
    },
    {
        "id": "447e6810-5047-47c5-b4dc-740132ede06c",
        "email": "new.user@company.ru",
        "firstName": "Дмитрий",
        "lastName": "Менделеев",
        "group": "reader",
        "active": true
    }
]

PUT /user - редактирование пользователя. Для использования данного АПИ нужно обладать правами уровня admin.

Обязательные заголовки:

Параметры запроса:

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

{
    "id": "447e6810-5047-47c5-b4dc-740132ede06c",
    "username":"new.user@company.ru", 
    "group":"author"
}

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

{
    "status": "Success",
    "message": "Updated successfully.",
    "id": "1a9b5d60-2a84-4edc-8751-ce0d28f153b6"
}

DELETE /user - полное удаление данных пользователя из БД, восстановление данных невозмжно. Для деактивации пользователя с сохранением данных используется АПИ PATCH /user. Для использования данного АПИ нужно обладать правами уровня admin.

Обязательные заголовки:

Параметры запроса:

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

{
    "id": "447e6810-5047-47c5-b4dc-740132ede06c",
}

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

{
    "status": "Success",
    "message": "Deleted successfully."
}

POST /folder - добавляет новую папку. Для использования данного АПИ нужно обладать правами уровня author.

Обязательные заголовки:

Параметры запроса:

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

{
    "name": "Folder name", 
    "order": "1", 
    "parentId": "iewoiojwe-kmslkglrk-j989f8wu9uf"
}

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

{
    "status": "Success",
    "message": "Created successfully.",
    "id": "a8d90a7a-5533-45d0-9fdc-47e5fbd8156a"
}

GET /folder/list - получение списка папок. Для использования данного АПИ нужно обладать правами уровня reader.

Обязательные заголовки:

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

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

[
    {
        "id": "df8f5f89-b93a-4b71-a5ee-2340ecc387e5",
        "name": "Отдел ИТ",
        "order": 0,
        "parentId": null,
        "children": [
            {
                "id": "347b7fe2-0eab-40c5-b1c1-06f73fdeccad",
                "name": "Документация",
                "order": 0,
                "parentId": "df8f5f89-b93a-4b71-a5ee-2340ecc387e5"
            },
            {
                "id": "d8f614ac-b74c-4da9-9be3-a0facbd23a6f",
                "name": "Список сотрудников",
                "order": 1,
                "parentId": "df8f5f89-b93a-4b71-a5ee-2340ecc387e5"
            }
        ]
    },
    {
        "id": "f3386450-ed39-47fe-a0ea-05f876dc817b",
        "name": "Отдел маркетинга",
        "order": 2,
        "parentId": null
    },
    {
        "id": "a8d90a7a-5533-45d0-9fdc-47e5fbd8156a",
        "name": "folder name",
        "order": 1,
        "parentId": null
    }
]

PATCH /folder - редактирование папки. Для использования данного АПИ нужно обладать правами уровня author.

Обязательные заголовки:

Параметры запроса:

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

{
    "id": "a8d90a7a-5533-45d0-9fdc-47e5fbd8156a",
    "name": "Folder name edited", 
    "order": "0", 
    "parentId": "e5ab2ojwe-kae9kglrw-g434f8wu7qa"
}

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

{
    "status": "Success",
    "message": "Updated successfully."
}

DELETE /folder - полное удаление папки и её содержимого из БД. Для деактивации папки с сохранением данных в БД используется АПИ PATCH /folder. Для использования данного АПИ нужно обладать правами уровня author.

Обязательные заголовки:

Параметры запроса:

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

{
    "id": "a8d90a7a-5533-45d0-9fdc-47e5fbd8156a",
    "deleteDescendents":true
}

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

{
    "status": "Success",
    "message": "Deleted successfully."
}

POST /doc - добавляет новый документ. Для использования данного АПИ нужно обладать правами уровня author.

Обязательные заголовки:

Параметры запроса:

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

{
    "title": "Doc title", 
    "order": "1", 
    "folderId": "iewoiojwe-kmslkglrk-j989f8wu9uf",
    "status":0,

}

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

{
    "status": "Success",
    "message": "Created successfully.",
    "id": "d476b3e3-cb3b-4ec7-a948-35580baeb7eb"
}

GET /doc/{id} - получение документа с идентификатором {id}. Возвращает последнюю версию документа (о версиях см. ниже). Для использования данного АПИ нужно обладать правами уровня reader.

Обязательные заголовки:

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

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

{
    "id": "f7a817af-2b50-404e-a63f-771ee31be27a",
    "title": "Оферта для пользователей",
    "order": 0,
    "folderId": "f3386450-ed39-47fe-a0ea-05f876dc817b",
    "status": 1,
    "type": "html",
    "body": "текст оферты"
}

GET /doc/{id}/version - получение списка версий документа. При каждом обновлении документа с помощью АПИ /doc/edit сохраняется новая версия документа. Это позволяет, при необходимости, вернуться к ранним версиям документа. Для использования данного АПИ нужно обладать правами уровня reader.

Обязательные заголовки:

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

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

[
    {
        "version": 1,
        "status": 0,
        "createdAt": "2021-05-18T18:53:58.879Z",
        "type": "text/plain"
    },
    {
        "version": 2,
        "status": 1,
        "createdAt": "2021-05-18T19:11:54.474Z",
        "type": "text/plain"
    },
    {
        "version": 3,
        "status": 1,
        "createdAt": "2021-05-18T19:28:03.404Z",
        "type": "text/plain"
    },
    {
        "version": 4,
        "status": 1,
        "createdAt": "2021-05-18T19:30:02.735Z",
        "type": "text/plain"
    }
]

GET /doc/{id}/version/{number} - получение конкретной версии документа. Для использования данного АПИ нужно обладать правами уровня reader.

Обязательные заголовки:

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

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

{
    "version": 3,
    "status": 1,
    "createdAt": "2021-05-18T19:28:03.404Z",
    "type": "text/html",
    "body": "Третья редакция текста оферты"
}

GET /doc/{id}/status/{status} - получение документа с идентификатором {id} и статусом {status} (может иметь значения 0 или 1). Возвращает последнюю версию документа в указанном статусе. Можно использовать для получения последней опубликованной версии, при наличии более поздних версий в статусе "черновик". Для использования данного АПИ нужно обладать правами уровня reader.

Обязательные заголовки:

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

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

{
    "id": "f7a817af-2b50-404e-a63f-771ee31be27a",
    "title": "Оферта для пользователей",
    "order": 0,
    "folderId": "f3386450-ed39-47fe-a0ea-05f876dc817b",
    "status": 1,
    "type": "html",
    "body": "текст оферты"
}

GET /doc/list - получение списка всех документов. Для использования данного АПИ нужно обладать правами уровня reader.

Обязательные заголовки:

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

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

[
    {
        "id": "f7a817af-2b50-404e-a63f-771ee31be27a",
        "title": "Оферта для пользователей",
        "order": 0,
        "active": true,
        "folderId": "f3386450-ed39-47fe-a0ea-05f876dc817b"
    },
    {
        "id": "a9506e6f-b519-4768-a1c1-4ed01f5c3282",
        "title": "Описание структуры отдела",
        "order": 1,
        "active": true,
        "FolderId": "df8f5f89-b93a-4b71-a5ee-2340ecc387e5"
    },
    {
        "id": "9ebd51b0-d05b-44d9-bbae-8d9c9333218b",
        "title": "Описание структуры отдела",
        "order": 0,
        "active": true,
        "FolderId": "df8f5f89-b93a-4b71-a5ee-2340ecc387e5"
    }
]

PATCH /doc - редактирование документа. Для использования данного АПИ нужно обладать правами уровня author.

Обязательные заголовки:

Параметры запроса:

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

{
    "id": "f7a817af-2b50-404e-a63f-771ee31be27a",
    "title": "Новый заголовок", 
    "body": "Новое тело документа"
}

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

{
    "status": "Success",
    "message": "Updated successfully."
}

DELETE /doc - полное удаление документа из БД. Для деактивации документа с сохранением данных в БД используется АПИ PATCH /doc. Для использования данного АПИ нужно обладать правами уровня author.

Обязательные заголовки:

Параметры запроса:

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

{
    "id": "f7a817af-2b50-404e-a63f-771ee31be27a"
}

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

{
    "status": "Success",
    "message": "Deleted successfully."
}

GET /content/doc/{id} - метод возвращает контент документа (body), в отличии от метода GET /doc/{id}, который возвращает json со всеми данными документа. Заголовок Content-Type, при этом, равен полю type. В ответе присылается старшая версия документа в статусе "чистовик" (status=1). Если у документа нет "чистовых" версий, то в ответе будет ошибка 404 Not Found с описанием "No published version found". Если в настройках определены стадии публикации, то в ответе будет приходить контент старшей "чистовой" версии (status=1) опубликованной на стадии с максимльным Порядком (order). Если на стадии с максимальным Порядком нет версий докумета в статусе "чистовик", либо нет чистовиков, которые согласованы и опубликованы, то в ответе будет ошибка 404 Not Found.

Обязательные заголовки:

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

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

Третья редакция текста оферты

GET /content/doc/{id}/stage/{name} - метод аналогичен методу GET /content/doc/{id}, с той разницей, что возвращает контент для конкретной стадии публикации, а не для стадии с максимальным порядком. Данный метод используется для отображения документа на выбранной среде (dev, stage, prod). Подробнее об этом рассказано в примере.

Обязательные заголовки:

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

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

Третья редакция текста оферты

GET /public/doc/{id} - если у документа установлено свойство isPublic равное true, то при добавлении /public в URL path к документу, его можно будет получить без авторизации. В остальном его работа аналогична методу GET /content/doc/{id}

Обязательные заголовки:

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

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

Третья редакция текста оферты

PUT /doc/{id}/version/{number}/status/1 - отправка указанной версии документа на публикацию. Для использования данного АПИ нужно обладать правами уровня author. Если в настройках не определены стадии публикации, то документ сразу становится доступным по ссылке GET /doc/{id}/content. Если стадии публикации определены в настройках, то для каждой стадии необходимо пройти процесс согласования и публикации, после чего документ становится доступен по ссылке GET /doc/{id}/content/stage/{stageName}. Подробнее о стадиях - тут

Обязательные заголовки:

Параметры запроса:

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

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

{
    "status":"Success",
    "message":"Updated successfully.",
    "id":"d5f7e857-6bd2-421f-857d-7cbaa42a36c6"
}

POST /doc/approval - согласование публикации указанной версии документа. Для согласования пользователь должен быть указан в качестве согласующего в настройках стадии публикации.

Обязательные заголовки:

Параметры запроса:

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

{
    "documentId":"c6d198f8-4c1b-4926-a0e7-eaad27d3e869",
    "version":12,
    "stageId":"aa977885-7a2f-4b54-b046-8c3353e400a7"
}

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

{
    "status": "Success",
    "message": "Approved successfully."
}

DELETE /doc/approval - отмена согласования публикации. Права на отмену согласования есть у пользователя, который поставил согласование, и у админа. Отменить согласование возможно только до момента публикации документа. Чтобы отменить согласование уже опубликованного документа, необходимо сначала отменить публикацию.

Обязательные заголовки:

Параметры запроса:

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

{
    "id":"330e1449-8eb7-4691-8556-1484cad9059b"
}

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

{
    "status": "Success",
    "message": "Approval has been cancelled successfully."
}

GET /doc/{id}/version/{number}/approval - получение списка согласований для указанной версии. Для использования данного АПИ нужно обладать правами уровня author.

Обязательные заголовки:

Параметры запроса:

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

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

[
        {
            "approvalId": "5ac7c452-8aa2-42b2-9ddc-d51b0867dee9",
            "approvedAt": "2020-04-16T19:42:42.934Z",
            "userId": "b850a4cc-071d-4b6a-9692-caec0db28429",
            "userFirstName": "Иван",
            "userLastName": "Павлов",
            "publishStage": {
                "id":"aa977885-7a2f-4b54-b046-8c3353e400a7",
                "name":"Dev",
                "order":1,
                "autoPublish":false
            }
        },
        {
            "approvalId": "7b725389-fdc4-483d-8046-83ef79da7d61",
            "approvedAt": "2020-04-17T08:32:11.459Z",
            "userId": "451ca4c0-88bd-4a8d-523e-abc2a9928783",
            "userFirstName": "Дмитрий",
            "userLastName": "Менделеев",
            "publishStage": {
                "id":"aa977885-7a2f-4b54-b046-8c3353e400a7",
                "name":"Dev",
                "order":1,
                "autoPublish":false
            }
        }
]

POST /doc/approval - публикация указанной версии документа. Для публикации пользователь должен быть указан в качестве публикующего в настройках стадии публикации. Для публикации версия должна быть предварителльно согласована, в противном случае, АПИ вернёт ошибку.

Обязательные заголовки:

Параметры запроса:

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

{
    "documentId":"c6d198f8-4c1b-4926-a0e7-eaad27d3e869",
    "version":12,
    "stageId":"aa977885-7a2f-4b54-b046-8c3353e400a7"
}

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

{
    "status": "Success",
    "message": "Published successfully."
}

DELETE /doc/publication - отмена публикации. Права на отмену публикации есть у пользователя, который опубликовал, и у админа.

Обязательные заголовки:

Параметры запроса:

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

{
    "id":"330e1449-8eb7-4691-8556-1484cad9059b"
}

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

{
    "status": "Success",
    "message": "Publication has been cancelled successfully."
}

GET /doc/{id}/version/{number}/publication - получение списка публикаций для указанной версии. Для использования данного АПИ нужно обладать правами уровня author.

Обязательные заголовки:

Параметры запроса:

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

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

[
        {
            "publicationId": "aa71dbd9-1609-4ff4-a097-40222933b9cf",
            "publishedAt": "2020-04-16T20:14:12.723Z",
            "userId": "b850a4cc-071d-4b6a-9692-caec0db28429",
            "userFirstName": "Иван",
            "userLastName": "Павлов",
            "publishStage": {
                "id":"aa977885-7a2f-4b54-b046-8c3353e400a7",
                "name":"Dev",
                "order":1,
                "autoPublish":false
            }
        },
        {
            "publicationId":"5a7b0c34-c776-4283-a6a7-c9d8dca6dbfa",
            "publishedAt": "2020-04-20T12:45:51.309Z",
            "userId": "451ca4c0-88bd-4a8d-523e-abc2a9928783",
            "userFirstName": "Дмитрий",
            "userLastName": "Менделеев",
            "publishStage": {
                "id":"aa977885-7a2f-4b54-b046-8c3353e400a7",
                "name":"Stage",
                "order":2,
                "autoPublish":false
            }
        }
]

GET /setting/list - получение списка настроек текущего аккаунта организации. Для использования данного АПИ нужно обладать правами уровня admin.

Обязательные заголовки:

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

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

[
        {
            "id":"allowSelfRegistration",
            "title":"Самостоятельная регистация"
        },
        {
            "id":"publishStage",
            "title":"Настройки согласования и публикации"
        }
    ]

GET /setting/allowSelfRegistration - получение настроек самостоятельной регистрации. Для использования данного АПИ нужно обладать правами уровня admin.

Обязательные заголовки:

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

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

{
    "organizationId": "1dfece35-e353-467c-8984-54896648fa9d", 
    "allowSelfRegistration": true,
    "id": "allowSelfRegistration"
}

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

PUT /setting/allowSelfRegistration - изменение настроек самостоятельной регистрации. Для использования данного АПИ нужно обладать правами уровня admin.

Обязательные заголовки:

Параметры запроса:

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

{
    "allowSelfRegistration": true
}

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

{
    "status": "Success", 
    "message": "Updated successfully.",
    "id": "allowSelfRegistration"
}

Стадии публикации определяют этапы (стадии) через которые проходит документ прежде чем он оказывается опубликованным на боевом сервере. Изначально никаких стадий в настройках организации не определено. Это значит, что документ после публикации может сразу быть доступен на боевом сервере.

Публикация - это изменение статуса документа (точнее, определённой версии документа) с черновика (status=0) на опубликованный (status=1). Если никаких стадий публикации в настройках не определено, то данная версия сразу после изменения статуса становится доступна через АПИ GET /doc/{id}/content. При этом, в ответе приходит не json с мета данными о документе, а сам документ (контент) с заголовком Content-type, равным значению, указанному в поле type при создании/редактировании документа.

Этот АПИ можно использовать в сторонней системе, чтобы отобразить документ конечному пользователю. Например, по этой ссылке можно отобразить Пользовательское соглашение. Пока документ редактируется, новые версии создаются с статусе "черновик", если какую-то версию (необязательно последнюю) переввести в статус "опубликовано", то она становится доступна через АПИ GET /doc/{id}/content. АПИ возвращает самую большую из опубликованных версий.

Если нам необходимо, чтобы документ перед тем, как стать доступным в АПИ, был согласован кем-то из сотрудников, то мы создаём стадию. Для стадии можно определить несколько согласующих. Только после того, как все согласующие согласуют документ, он может быть опубликован. Для публикации можно также назначить сотрудника, либо указать, что публикация происходит автоматически, после получения всех согласований. При наличии стадии документ проходит следующие этапы:

• отправка на публикацию (смена статуса с status=0 на status=1)
• получение согласований от всех назначенных сотрудников
• публикация (в ручном или автоматическом режиме)

После публикации документ становится доступен по АПИ GET /doc/{id}/content/stage/{stageName}, при этом АПИ GET /doc/{id}/content будет возвращать ошибку "Необходимо указать стадию".

Если нам необходимо иметь возможность раздельной публикации документа на нескольких серверах, например, нужно проверять документ на тестовом сервере, прежде чем публиковать на боевом, то необходимо определить несколько стадий. Например, test и prod. У каждой стадии будут назначены свои согласующие и свои публикующие сотрудники. В этом случае, документ будет проходить следующие этапы:

• отправка на публикацию (смена статуса с status=0 на status=1)
• получение согласований от всех назначенных сотрудников на стадии test
• публикация (в ручном или автоматическом режиме) на стадии test
• документ становится доступен по АПИ GET/doc/{id}/content/stage/test
• документ становится доступным для согласования на стадии prod
• получение согласований от всех назначенных сотрудников на стадии prod
• публикация (в ручном или автоматическом режиме) на стадии prod
• документ становится доступен по АПИ GET /doc/{id}/content/stage/prod

На серверах test и prod формат ссылки определяется в конфиге.

Таким образом, процесс для сотрудников может выглядеть так:

• автор изменений в документе отправляет новую версию на публикацию
• он сам или его руководитель согласовывают публикацию на стадии test
• новая версия автоматически публикуется на тестовом сервере
• документ становится доступным для согласования на стадии prod
• тестировщики проверяют документ на тестовом сервере и согласовывают стадию prod
• руководитель проекта публикует стадию prod
• документ становится опубликован и доступен на prod сервере

Количество стадий не ограничено.

POST /setting/publishStage - cоздание стадии публикации. Для использования данного АПИ нужно обладать правами уровня admin.

Обязательные заголовки:

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

{
    "name":"test",
    "order":"1",
    "approvers":[
        {"userId":"fa312064-2af5-4d3b-9961-a3bd235ebdf8"},
        {"userId":"fa312064-2af5-4d3b-9961-a3bd235ebdf8"}
    ],
    "publishers":[
        {"userId":"b850a4cc-071d-4b6a-9692-caec0db28429"}
    ]
}

Параметры запроса:

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

{
    "status": "Success",
    "message": "Added successfully.",
    "id": "7b725389-fdc4-483d-8046-83ef79da7d61"
}

PUT /setting/publishStage/{id} - редактирование стадии публикации. Для использования данного АПИ нужно обладать правами уровня admin.

Обязательные заголовки:

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

{
    "name":"test",
    "order":"1",
    "approvers":[
        {"userId":"fa312064-2af5-4d3b-9961-a3bd235ebdf8"},
        {"userId":"fa312064-2af5-4d3b-9961-a3bd235ebdf8"}
    ],
    "publishers":[],
    "autoPublish": true
}

Параметры запроса:

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

{
    "status": "Success",
    "message": "Updated successfully.",
    "id": "35d8b3c7-edd3-4adf-9043-bc9693e77d44"
}

GET /setting/publishStage/ - получение списка стадий публикации. Для использования данного АПИ нужно обладать правами уровня admin.

Обязательные заголовки:

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

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

[
    {
        "id": "35d8b3c7-edd3-4adf-9043-bc9693e77d44",
        "name": "Test",
        "order": "1",
        "approvers": [
            {
                "id": "fa312064-2af5-4d3b-9961-a3bd235ebdf8",
                "email": "alexander.popov@company.ru",
                "firstName": "Alexander",
                "lastName": "Popov"
            },
            {
                "id": "fa312064-2af5-4d3b-9961-a3bd235ebdf8",
                "email": "ivan.pavlov@company.ru",
                "firstName": "Ivan",
                "lastName": "Pavlov"
            }
        ],
        "publishers": [],
        "autoPublish": true
    },
    {
        "id": "b98dc36d-1d8f-4bac-8c1f-8c6087dc1929",
        "name":"Prod",
        "order":"2",
        "approvers":[
            {
                "id": "fa312064-2af5-4d3b-9961-a3bd235ebdf8",
                "email": "alexander.popov@company.ru",
                "firstName": "Alexander",
                "lastName": "Popov"
            },
            {
                "id": "fa312064-2af5-4d3b-9961-a3bd235ebdf8",
                "email": "ivan.pavlov@company.ru",
                "firstName": "Ivan",
                "lastName": "Pavlov"
            }
        ],
        "publishers":[
            {
                "id": "fa312064-2af5-4d3b-9961-a3bd235ebdf8",
                "email": "ivan.pavlov@company.ru",
                "firstName": "Ivan",
                "lastName": "Pavlov"
            }
        ],
    }
]

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

GET /setting/publishStage/{id} - получение стадии публикации. Для использования данного АПИ нужно обладать правами уровня admin.

Обязательные заголовки:

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

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

{
    "id": "35d8b3c7-edd3-4adf-9043-bc9693e77d44",
    "name": "Test",
    "order": "1",
    "approvers": [
        {
            "id": "fa312064-2af5-4d3b-9961-a3bd235ebdf8",
            "email": "alexander.popov@company.ru",
            "firstName": "Alexander",
            "lastName": "Popov"
        },
        {
            "id": "fa312064-2af5-4d3b-9961-a3bd235ebdf8",
            "email": "ivan.pavlov@company.ru",
            "firstName": "Ivan",
            "lastName": "Pavlov"
        }
    ],
    "publishers": [],
    "autoPublish": true
}

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

DELETE /setting/publishStage/ - удаление стадии публикации. Для использования данного АПИ нужно обладать правами уровня admin.

Обязательные заголовки:

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

{
    "id":"35d8b3c7-edd3-4adf-9043-bc9693e77d44"
}

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

{
    "status": "Success",
    "message": "Deleted successfully."
}