Загрузить файл в хранилище проекта

Кладёт файл в хранилище проекта. Картинка, запись или документ приходят в теле запроса как base64. Дальше этот файл можно прикрепить к задаче, товару или звонку.

Scope

files:write

Заголовки

Content-Type: application/json
X-Api-Key — ключ проекта
Idempotency-Key — для повторного запроса с тем же результатом

Загрузить файл в хранилище проекта

POST /v1/files/upload. Scope files:write.

Учебный пример магазина «Северная полка». Это не запись из вашей базы. Здесь файл: запрос и ответ на одном вызове.

Запрос

{
  "data": {
    "projectId": "11111111-1111-4111-8111-111111111111",
    "fileName": "kruzhka-emal.png",
    "mimeType": "image/png",
    "bucket": "attachments",
    "fileBase64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="
  }
}

Ответ (успех, 200)

{
  "success": true,
  "data": {
    "bucket": "attachments",
    "path": "projects/demo/kruzhka-emal.png",
    "fileName": "kruzhka-emal.png",
    "mimeType": "image/png"
  }
}

Пример cURL

curl -X POST "https://api-external.brifly.online/v1/files/upload" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: {{api_key}}" \
  -d '{"data": {"projectId": "11111111-1111-4111-8111-111111111111", "fileName": "kruzhka-emal.png", "mimeType": "image/png", "bucket": "attachments", "fileBase64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="}}'

Ошибки

401 INVALID_API_KEY — нет ключа или ключ отозван.
403 FORBIDDEN_SCOPE — у ключа нет files:write.
403 PROJECT_MISMATCH — в теле другой проект.
429 RATE_LIMIT_EXCEEDED — заголовок Retry-After.
400 VALIDATION_ERROR — не хватает поля в data.

Ограничения

Проект и пользователь берутся из ключа. Чужой data.projectId отвечает 403 PROJECT_MISMATCH.

Scope

Заголовки

Загрузить файл в хранилище проекта

Запрос

Ответ (успех, 200)

Пример cURL

Ошибки

Ограничения

См. также