Перейти к содержанию

API для работы с хранилищем $

Описание

В этом разделе описаны методы API для создания, удаления и изменения файлов и папок в вашем хранилище, а также для создания и получения задач транскодирования.

Общие сведения

  • Обязательные заголовки: CDN-AUTH-TOKEN (авторизационный токен, см. Авторизация)
  • Content-Type ответа: application/json
  • Все ответы, включая ошибки, возвращаются в общей структуре: всегда (за исключением 204-го кода ответа) возвращается ключ status; в случае успешного ответа возвращается ключ data с данными ответа, где это применимо, в противном случае иногда возвращается ключ description с описанием ошибки.

  • Возможные значения ключа status:

    Код ответа Значение status
    200, 201 Completed
    202 Partially completed
    4xx, 5xx Ошибочный статус

Общие ошибки

В ответ на любой из запросов может вернуться одна из следующих ошибок:

Код ответа status description Описание
401 Unauthorized Invalid token Не передан заголовок с токеном
403 Forbidden No domain created Хранилище не инициализировано*
403 Forbidden Invalid account В URL-е был указан неверный аккаунт
404 Not Found - Неверный URL
405 Method Not Allowed Method is not allowed Отказано в доступе к действию**
500 Internal Server Error - Внутренняя ошибка сервера

Обратите внимание

* - для инициализации хранилища аккаунта необходимо сделать POST-запрос "Создать файл/папку" по любому пути
** - одна из возможных причин - недействительный токен (см. Авторизация)

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

curl 'https://api-cdn.platformcraft.com/app/storage/v1/testaccount/files'

Пример неуспешного ответа

{
  "status": "Unauthorized",
  "description": "Invalid token"
}