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

Авторизация

Описание:
Получение токена для вызова методов API требующих авторизации.
Этот метод апи не требует авторизации.

Тип: JSON

Параметры запроса:
* - Обязательное поле.

*email (строка) - Email зарегистрированного пользователя.
*password (строка) - Пароль зарегистрированного пользователя.

Запрос на получение токена

curl -d '{"email":"test@localhost", "password":"123321"}' -H "Content-Type: application/json" -X POST https://api.printdoc.io/v1/auth

Успешный ответ. Код: 200.

{
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2MTQ5NDY0NjF9.ZgiK8xrAhYNJir2PysGkalT-B6gt1e4byprY9BcjS8o"
}

Полученный токен из поля «token», необходимо передавать в заголовке «Authorization» с префиксом «Token», для всех апи требующих авторизации.

Пример правильной передачи заголовка «Authorization».

Получим все шаблоны для авторизированного пользователя.
curl -i https://api.printdoc.io/v1/template -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2MTQ5NDY0NjF9.ZgiK8xrAhYNJir2PysGkalT-B6gt1e4byprY9BcjS8o"

Полученный токен из поля «token», имеет срок жизни - 1 час. После сгорания токена его необходимо получить заного.

Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Authentication failed."
  ],
  "exception": "AuthenticationFailed"
}

Шаблоны

Описание:
Получение всех активных шаблонов авторизированного пользователя.
Этот метод апи требует авторизации.
Этот метод апи требует передачи заголовка «Authorization» с токеном.

Получить все шаблоны для авторизированного пользователя.

curl -i https://api.printdoc.io/v1/template -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2MTQ5NDY0NjF9.ZgiK8xrAhYNJir2PysGkalT-B6gt1e4byprY9BcjS8o"

Успешный ответ. Код: 200.

{
  "message": "Your templates.",
  "templates": [
    {
      "template_id": 1,
      "template_name": "тестовый",
      "template": "templates/test@localhost/2021-03-06/(1) Programma_provedenia_regionalnykh_UTS_24_11_2018.docx",
      "update_date": "2021-03-06",
      "category": [
        {
          "category_id": 1,
          "category_name": "категория 1"
        }
      ],
      "linked_docs": [
        {
          "document_id": 2,
          "document_name": "(2) (1) Programma_provedenia_regionalnykh_UTS_24_11_2018.docx"
        },
        {
          "document_id": 1,
          "document_name": "(1) (1) Programma_provedenia_regionalnykh_UTS_24_11_2018.docx"
        }
      ]
    }
  ]
}

Параметры:

  • template_id - ид шаблона
  • template_name - название шаблона
  • template - путь к шаблону в файловой системе
  • update_date - дата последнего изменения шаблона
  • update_date - категория шаблона
  • category - категория шаблона
    • category_id - ид категории для шаблона
    • category_name - название категории для шаблона
  • linked_docs - документы использующие данный шаблон
    • document_id - ид связанного с шаблоном документа
    • document_name - название связанного с шаблоном документа
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Signature has expired."
  ],
  "exception": "Unauthorized"
}
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Authorization header not present."
  ],
  "exception": "Unauthorized"
}

Описание:
Создание нового шаблона для авторизированного пользователя.
Этот метод апи требует авторизации.
Этот метод апи требует передачи заголовка «Authorization» с токеном.

Тип: FORMDATA

Параметры запроса:
* - Обязательное поле.

template_name (строка) - Название для нового шаблона.
Название должно быть уникальным!
Если поле названия не заполнено, оно будет идентично имени файла шаблона!
*file (файл *.docx) - docx файл шаблона.
  • Поддерживаются только *.docx файлы
  • Максимальный размер загружаемого файла: 2.1 MB
category_id (число) - Ид категории для шаблона.
Создать новый шаблон для авторизированного пользователя.

Если имя загружаемого файла шаблона уже есть в системе, к имени будет добавлен префикс (n).
Где n - количество повторений загружаемого имени файла.
Загруженному первый раз файлу шаблона, будет присвоен префикс: (1)
curl -X POST -F 'template_name="тестовый документ 2"' -F "category_id=1" -F "file=@nc-1611340958506.docx" https://api.printdoc.io/v1/template -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2MTUwNTA0NTV9.nnIvlEP8cbuTCAu-Dd_v6rEkFoWag5-F-lN-mjqw1G8" -H "Content-Type: multipart/form-data"

Успешный ответ. Код: 201.

{
  "message": "The template тестовый документ 2 has been added.",
  "template_id": 3,
  "template_name": "тестовый документ 2",
  "template_file": "(1) nc-1611340958506.docx",
  "category": [
    {
      "category_id": 1,
      "category_name": "категория 1"
    }
  ]
}

Параметры:

  • template_id - ид шаблона
  • template_name - название шаблона
  • template_file - имя загруженного файла шаблона с префиксом
  • category - категория шаблона
    • category_id - ид категории для шаблона
    • category_name - название категории для шаблона
Неуспешный ответ. Код: 400.

{
  "message": "XXX"
}
Где XXX:
  • «Field name» is a required property - Не заполнено одно из обязательных полей.
  • File for upload not found. - Файл шаблона не найден в отправляемых данных.
  • The upload file is too large. - Файл шаблона слишком большой.
  • Only docx files are supported. - Формат загруженного файла шаблона не соотвествует *.docx формату.
  • Invalid data required to create a template. - Не хватает данных для создания шаблона.
  • No such file or directory. - Ошибка при попытке прочитать файла шаблона на сервере.
  • Duplicate field value template_name - Название шаблона должно быть уникальным.
  • The requested resource does not exist or an error occurred while working with the database. - Ошибка при работе с БД.
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Signature has expired."
  ],
  "exception": "Unauthorized"
}
Неуспешный ответ. Код: 401.

{
"reasons": [
"Authorization header not present."
],
"exception": "Unauthorized"
}

Описание:
Изменение существующего шаблона для авторизированного пользователя.
Этот метод апи требует авторизации.
Этот метод апи требует передачи заголовка «Authorization» с токеном.

Тип: JSON

Параметры запроса:
* - Обязательное поле.

*template_id (число) - Ид шаблона для изменения
template_name (строка) - Новое название для существующего шаблона.
Название должно быть уникальным!
category_id (число) - Ид категории для шаблона.
Изменить существующий шаблон для авторизированного пользователя.

Будут изменены только те поля, которые были указаны. Значения остальных полей, не поменяется.
Если Вы хотите убрать установленную у шаблона категорию, в поле «category_id», передайте значение - 0.
Для примера, поменяем название, ид категории, у шаблона с template_id=1.
curl -X PATCH -F 'template_name="новое название тестовый документ"' -F "category_id=2" -F "template_id=1" https://api.printdoc.io/v1/template -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2MTUwNjE5MDd9.3P2i3_yHNyoiU3AXK-TeAZJhk9QIIoC8n9TCUcHU1bQ" -H "Content-Type: multipart/form-data"

Успешный ответ. Код: 200.

{
  "message": "The template новое название тестовый документ has been updated.",
  "template_id": 1,
  "template_name": "новое название тестовый документ",
  "template_file": "(1) Programma_provedenia_regionalnykh_UTS_24_11_2018.docx",
  "category": [
    {
      "category_id": 2,
      "category_name": "категория 2"
    }
  ]
}

Параметры:

  • template_id - ид шаблона
  • template_name - название шаблона
  • template_file - имя загруженного файла шаблона с префиксом
  • category - категория шаблона
    • category_id - ид категории для шаблона
    • category_name - название категории для шаблона
Неуспешный ответ. Код: 400.

{
  "message": "XXX"
}
Где XXX:
  • «Field name» is a required property - Не заполнено одно из обязательных полей.
  • File for upload not found. - Файл шаблона не найден в отправляемых данных.
  • The upload file is too large. - Файл шаблона слишком большой.
  • Only docx files are supported. - Формат загруженного файла шаблона не соотвествует *.docx формату.
  • Invalid data required to create a template. - Не хватает данных для создания шаблона.
  • No such file or directory. - Ошибка при попытке прочитать файла шаблона на сервере.
  • Duplicate field value template_name - Название шаблона должно быть уникальным.
  • The requested resource does not exist or an error occurred while working with the database. - Ошибка при работе с БД.
  • At least one of the fields required for updating must be filled. - Хотя бы одно из полей необходимых для обновления должно быть заполнено.
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Signature has expired."
  ],
  "exception": "Unauthorized"
}
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Authorization header not present."
  ],
  "exception": "Unauthorized"
}

Описание:
Удаление существующего шаблона для авторизированного пользователя.
Этот метод апи требует авторизации.
Этот метод апи требует передачи заголовка «Authorization» с токеном.

Тип: JSON

Параметры запроса:
* - Обязательное поле.

*template_id (массив) - Ид шаблона(ов) для удаления
Можно удалить один или несколько шаблонов за один вызов.
delete_linked_docs (булево) - Удалить связанные с шаблоном документы

Удалить один, или несколько существующих шаблонов для авторизированного пользователя.

Удалим шаблон с template_id=1.
И связанные с этим шаблоном документы.
curl -d '{"template_id": [1], "delete_linked_docs": true}' -H "Content-Type: application/json" -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2MTUwNjE5MDd9.3P2i3_yHNyoiU3AXK-TeAZJhk9QIIoC8n9TCUcHU1bQ" -X DELETE https://api.printdoc.io/v1/template

Успешный ответ. Код: 200.

{
    "message":"Templates (including documents) removed.",
    "deleted_templates_id":[1],
    "delete_linked_docs_id":[2,1]
}

Параметры:

  • deleted_templates_id - массив ид удаленных шаблонов
  • delete_linked_docs_id - массив ид удаленных связанных с шаблоном документов
Неуспешный ответ. Код: 400.

{
  "message": "XXX"
}
Где XXX:
  • An empty list of template values returned. - Массив ид шаблонов для удаления пустой.
  • «Field name» is a required property. - Не заполнено одно из обязательных полей.
  • File for upload not found. - Файл шаблона не найден в отправляемых данных.
  • The upload file is too large. - Файл шаблона слишком большой.
  • Only docx files are supported. - Формат загруженного файла шаблона не соотвествует *.docx формату.
  • Invalid data required to create a template. - Не хватает данных для создания шаблона.
  • No such file or directory. - Ошибка при попытке прочитать файла шаблона на сервере.
  • Duplicate field value template_name - Название шаблона должно быть уникальным.
  • The requested resource does not exist or an error occurred while working with the database. - Ошибка при работе с БД.
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Signature has expired."
  ],
  "exception": "Unauthorized"
}
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Authorization header not present."
  ],
  "exception": "Unauthorized"
}

Документы

Описание:
Получение всех активных документов авторизированного пользователя.
Этот метод апи требует авторизации.
Этот метод апи требует передачи заголовка «Authorization» с токеном.

Получить все документы для авторизированного пользователя.

curl -i https://api.printdoc.io/v1/docx -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2MTQ5NDY0NjF9.ZgiK8xrAhYNJir2PysGkalT-B6gt1e4byprY9BcjS8o"

Успешный ответ. Код: 200.

{
    "message":"Your documents.",
    "documents":[
        {
            "document_id":3,
            "document_name":"новый документ 1",
            "template_id":3,
            "category": [
            {
              "category_id": 1,
              "category_name": "категория 1"
            }
        ],
      }
    ]
}

Параметры:

  • document_id - ид документа
  • document_name - название документа
  • template_id - ид шаблона по которому создан документ
  • category - категория документа
    • category_id - ид категории для документа
    • category_name - название категории для документа
Неуспешный ответ. Код: 401.

{
"reasons": [
"Signature has expired."
],
"exception": "Unauthorized"
}
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Authorization header not present."
  ],
  "exception": "Unauthorized"
}

Описание:
Создание нового документа для авторизированного пользователя.
Этот метод апи требует авторизации.
Этот метод апи требует передачи заголовка «Authorization» с токеном.

Тип: JSON

Параметры запроса:
* - Обязательное поле.

*template_id (число) - Ид шаблона по которому будет создан документ.
*data (json) - Параметры которые будут переданы в шаблон.
document_name (строка) - Название документа.
Название должно быть уникальным!
Если поле названия не заполнено, оно будет идентично имени файла документа!
Если имя создаваемого файла документа уже есть в системе, к имени будет добавлен префикс (n).
Где n - количество повторений создаваемого имени файла.
Созданному первый раз файлу документа, будет присвоен префикс: (1)
category_id (число) - Ид категории для документа.
Создать новый документ для авторизированного пользователя.

Создадим новый документ на основе шаблона с template_id=3.
Передадим в шаблон параметры: {"param1": [1,2,3], "param2": "Hello document."}, которые отразятся в документе.
curl -d '{"template_id": 3, "data": {"param1": [1,2,3], "param2": "Hello document."}}' -H "Content-Type: application/json" -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2MTUxMDE2NjF9.Z3rO0DOgJrv3nREVQMu53EOhvWHexsqvV4XNMUX5ihU" -X POST https://api.printdoc.io/v1/docx

Успешный ответ. Код: 201.

{
    "message": "Document created. You can download by link in the browser.",
    "download_by_name": "https://api.printdoc.io/v1/download/2-1-nc-1611340958506-docx/token/9924d9936dafd83175d7dc4fb06e9fd2",
    "download_by_id": "https://api.printdoc.io/v1/download/4/token/9924d9936dafd83175d7dc4fb06e9fd2"
}

Параметры:

  • download_by_name - Ссылка для скачивания документа по ид
  • download_by_id - Ссылка для скачивания документа по названию
Неуспешный ответ. Код: 400.

{
  "message": "XXX"
}
Где XXX:
  • «Field name» is a required property - Не заполнено одно из обязательных полей.
  • File for upload not found. - Файл шаблона не найден в отправляемых данных.
  • The upload file is too large. - Файл шаблона слишком большой.
  • Only docx files are supported. - Формат загруженного файла шаблона не соотвествует *.docx формату.
  • Invalid data required to create a template. - Не хватает данных для создания шаблона.
  • No such file or directory. - Ошибка при попытке прочитать файла шаблона на сервере.
  • Duplicate field value template_name - Название шаблона должно быть уникальным.
  • The requested resource does not exist or an error occurred while working with the database. - Ошибка при работе с БД.
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Signature has expired."
  ],
  "exception": "Unauthorized"
}
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Authorization header not present."
  ],
  "exception": "Unauthorized"
}

Описание:
Изменение существующего документа для авторизированного пользователя.
Этот метод апи требует авторизации.
Этот метод апи требует передачи заголовка «Authorization» с токеном.

Тип: JSON

Параметры запроса:
* - Обязательное поле.

*document_id (число) - Ид документа для изменения
document_name (строка) - Новое название для существующего документа.
Название должно быть уникальным!
category_id (число) - Ид категории для документа.

Изменить существующий документ для авторизированного пользователя.

Будут изменены только те поля, которые были указаны. Значения остальных полей, не поменяется.
Если Вы хотите убрать установленную у документа категорию, в поле «category_id», передайте значение - 0.
Для примера, поменяем название, у документа с document_id=3.
curl -d '{"document_id": 3, "document_name": "легко меняем название документа"}' -H "Content-Type: application/json" -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2MTUxMDE2NjF9.Z3rO0DOgJrv3nREVQMu53EOhvWHexsqvV4XNMUX5ihU" -X PATCH https://api.printdoc.io/v1/docx

Успешный ответ. Код: 200.

{
"message":"Document updated.",
"document_id":3,
"document_name":"легко меняем название документа",
"category": [
    {
      "category_id": 2,
      "category_name": "категория 2"
    }
  ]
}

Параметры:

  • document_id - ид документа
  • document_name - название документа
  • category - категория документа
    • category_id - ид категории для документа
    • category_name - название категории для документа
Неуспешный ответ. Код: 400.

{
  "message": "XXX"
}
Где XXX:
  • «Field name» is a required property - Не заполнено одно из обязательных полей.
  • File for upload not found. - Файл шаблона не найден в отправляемых данных.
  • The upload file is too large. - Файл шаблона слишком большой.
  • Only docx files are supported. - Формат загруженного файла шаблона не соотвествует *.docx формату.
  • Invalid data required to create a template. - Не хватает данных для создания шаблона.
  • No such file or directory. - Ошибка при попытке прочитать файла шаблона на сервере.
  • Duplicate field value template_name - Название шаблона должно быть уникальным.
  • The requested resource does not exist or an error occurred while working with the database. - Ошибка при работе с БД.
  • At least one of the fields required for updating must be filled. - Хотя бы одно из полей необходимых для обновления, должно быть заполнено.
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Signature has expired."
  ],
  "exception": "Unauthorized"
}
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Authorization header not present."
  ],
  "exception": "Unauthorized"
}

Описание:
Удаление существующего документа для авторизированного пользователя.
Этот метод апи требует авторизации.
Этот метод апи требует передачи заголовка «Authorization» с токеном.

Тип: JSON

Параметры запроса:
* - Обязательное поле.

*document_id (массив) - Ид шаблона(ов) для удаления
Можно удалить один или несколько документов за один вызов.

Удалить один, или несколько существующих документов для авторизированного пользователя.

Удалим документ с document_id=3.
curl -d '{"document_id": [3]}' -H "Content-Type: application/json" -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2MTUwNjE5MDd9.3P2i3_yHNyoiU3AXK-TeAZJhk9QIIoC8n9TCUcHU1bQ" -X DELETE https://api.printdoc.io/v1/docx

Успешный ответ. Код: 200.

{
    "message":"Documents  removed.",
    "deleted_documents_id":[3]
}

Параметры:

  • deleted_documents_id - массив ид удаленных документов
Неуспешный ответ. Код: 400.

{
  "message": "XXX"
}
Где XXX:
  • An empty list of template values returned. - Массив ид шаблонов для удаления пустой.
  • «Field name» is a required property. - Не заполнено одно из обязательных полей.
  • File for upload not found. - Файл шаблона не найден в отправляемых данных.
  • The upload file is too large. - Файл шаблона слишком большой.
  • Only docx files are supported. - Формат загруженного файла шаблона не соотвествует *.docx формату.
  • Invalid data required to create a template. - Не хватает данных для создания шаблона.
  • No such file or directory. - Ошибка при попытке прочитать файла шаблона на сервере.
  • Duplicate field value template_name - Название шаблона должно быть уникальным.
  • The requested resource does not exist or an error occurred while working with the database. - Ошибка при работе с БД.
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Signature has expired."
  ],
  "exception": "Unauthorized"
}
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Authorization header not present."
  ],
  "exception": "Unauthorized"
}

Категории

Описание:
Получение всех категорий авторизированного пользователя.
Этот метод апи требует авторизации.
Этот метод апи требует передачи заголовка «Authorization» с токеном.

Получить все категории для авторизированного пользователя.

curl -i https://api.printdoc.io/v1/category -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2MTQ5NDY0NjF9.ZgiK8xrAhYNJir2PysGkalT-B6gt1e4byprY9BcjS8o"

Успешный ответ. Код: 200.

{
    "message":"Your categories.",
    "categories":[
        {
            "category_id":2,
            "category_name":"Категория 2"
        },
        {
            "category_id":1,
            "category_name":"Категория 1"
        }
    ]
}

Параметры:

  • categories - массив категорий
    • category_id - ид категории
    • category_name - название категории
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Signature has expired."
  ],
  "exception": "Unauthorized"
}
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Authorization header not present."
  ],
  "exception": "Unauthorized"
}

Описание:
Создание новой категории для авторизированного пользователя.
Этот метод апи требует авторизации.
Этот метод апи требует передачи заголовка «Authorization» с токеном.

Тип: JSON

Параметры запроса:
* - Обязательное поле.

*category_name (строка) - Название новой категории.
Название должно быть уникальным!

Создать новую категорию для авторизированного пользователя.

Создадим новую категорию с названием: Супер-категория.
curl -d '{"category_name": "Супер-категория"}' -H "Content-Type: application/json" -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2MTUxMDE2NjF9.Z3rO0DOgJrv3nREVQMu53EOhvWHexsqvV4XNMUX5ihU" -X POST https://api.printdoc.io/v1/category

Успешный ответ. Код: 201.

{
"message":"Category (Супер-категория) created.",
"category_id":3,
"category_name":"Супер-категория"
}

Параметры:

  • category_id - Ид созданной категории
  • category_name - Название созданной категории
Неуспешный ответ. Код: 400.

{
  "message": "XXX"
}
Где XXX:
  • «Field name» is a required property - Не заполнено одно из обязательных полей.
  • File for upload not found. - Файл шаблона не найден в отправляемых данных.
  • The upload file is too large. - Файл шаблона слишком большой.
  • Only docx files are supported. - Формат загруженного файла шаблона не соотвествует *.docx формату.
  • Invalid data required to create a template. - Не хватает данных для создания шаблона.
  • No such file or directory. - Ошибка при попытке прочитать файла шаблона на сервере.
  • Duplicate field value template_name - Название шаблона должно быть уникальным.
  • The requested resource does not exist or an error occurred while working with the database. - Ошибка при работе с БД.
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Signature has expired."
  ],
  "exception": "Unauthorized"
}
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Authorization header not present."
  ],
  "exception": "Unauthorized"
}

Описание:
Изменение существующей категории для авторизированного пользователя.
Этот метод апи требует авторизации.
Этот метод апи требует передачи заголовка «Authorization» с токеном.

Тип: JSON

Параметры запроса:
* - Обязательное поле.

*category_id (число) - Ид категории для изменения
*category_name (строка) - Новое название для существующей категории.
Название должно быть уникальным!

Изменить существующую категорию для авторизированного пользователя.

Для примера, поменяем название, у категории с category_id=3.
curl -d '{"category_id": 3, "category_name": "новое название для категории"}' -H "Content-Type: application/json" -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2MTUxMDE2NjF9.Z3rO0DOgJrv3nREVQMu53EOhvWHexsqvV4XNMUX5ihU" -X PATCH https://api.printdoc.io/v1/category

Успешный ответ. Код: 200.

{
"message":"Category updated.",
"category_id":3
}

Параметры:

  • category_id - ид категории
Неуспешный ответ. Код: 400.

{
  "message": "XXX"
}
Где XXX:
  • «Field name» is a required property - Не заполнено одно из обязательных полей.
  • File for upload not found. - Файл шаблона не найден в отправляемых данных.
  • The upload file is too large. - Файл шаблона слишком большой.
  • Only docx files are supported. - Формат загруженного файла шаблона не соотвествует *.docx формату.
  • Invalid data required to create a template. - Не хватает данных для создания шаблона.
  • No such file or directory. - Ошибка при попытке прочитать файла шаблона на сервере.
  • Duplicate field value template_name - Название шаблона должно быть уникальным.
  • The requested resource does not exist or an error occurred while working with the database. - Ошибка при работе с БД.
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Signature has expired."
  ],
  "exception": "Unauthorized"
}
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Authorization header not present."
  ],
  "exception": "Unauthorized"
}

Описание:
Удаление существующей категории для авторизированного пользователя.
Этот метод апи требует авторизации.
Этот метод апи требует передачи заголовка «Authorization» с токеном.

Тип: JSON

Параметры запроса:
* - Обязательное поле.

*category_id (массив) - Ид категории(й) для удаления
Можно удалить одну или несколько категорий за один вызов.

Удалить одну, или несколько существующих категорий для авторизированного пользователя.

Удалим категорию с category_id=3.
curl -d '{"category_id": [3]}' -H "Content-Type: application/json" -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2MTUwNjE5MDd9.3P2i3_yHNyoiU3AXK-TeAZJhk9QIIoC8n9TCUcHU1bQ" -X DELETE https://api.printdoc.io/v1/category

Успешный ответ. Код: 200.

{
    "message":"Category deleted.",
    "category_id":[3]
}

Параметры:

  • category_id - массив ид удаленных категорий
Неуспешный ответ. Код: 400.

{
  "message": "XXX"
}
Где XXX:
  • An empty list of template values returned. - Массив ид шаблонов для удаления пустой.
  • «Field name» is a required property. - Не заполнено одно из обязательных полей.
  • File for upload not found. - Файл шаблона не найден в отправляемых данных.
  • The upload file is too large. - Файл шаблона слишком большой.
  • Only docx files are supported. - Формат загруженного файла шаблона не соотвествует *.docx формату.
  • Invalid data required to create a template. - Не хватает данных для создания шаблона.
  • No such file or directory. - Ошибка при попытке прочитать файла шаблона на сервере.
  • Duplicate field value template_name - Название шаблона должно быть уникальным.
  • The requested resource does not exist or an error occurred while working with the database. - Ошибка при работе с БД.
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Signature has expired."
  ],
  "exception": "Unauthorized"
}
Неуспешный ответ. Код: 401.

{
  "reasons": [
    "Authorization header not present."
  ],
  "exception": "Unauthorized"
}