Skip to content

Документация внутреннего API Felmee (0.0.2)

Общий формат ответа для всех REST endpoints:

{
  "success": true,
  "message": "...",
  "codeError": null,
  "data": {}
}
Download OpenAPI description
OPENAPI.json
OPENAPI.yaml
Languages
Servers
Production
https://felmee.com

API Аунтефикации

Авторизация и токены

Operations

API работы с файлами

Загрузка и получение файлов

Operations

Загрузить файл

Request

Загрузка файла в хранилище. purpose определяет назначение и ограничения по типу/размеру.

Security
bearerAuth or jwtCookie
Bodymultipart/form-datarequired
filestring(binary)required
purposestring(FilePurpose)required
Enum"AVATAR""VOICE""MESSAGE"
curl -i -X POST \
  https://felmee.com/api/file/upload \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F purpose=AVATAR

Responses

Файл успешно загружен

Bodyapplication/json
dataobject or nullrequired

Полезная нагрузка (может быть null)

data.​file_idstringrequired

Object key / идентификатор загруженного файла

successbooleanrequired
messagestringrequired
codeErrorstring or nullrequired

Код ошибки (null в случае успеха)

One of:

Код ошибки (null в случае успеха)

string
Response
application/json
{
  "success": true,
  "message": "File upload successfully",
  "codeError": null,
  "data": {
    "file_id": "<object_key>"
  }
}

Получить файл по id (публичная ссылка)

Request

Получить доступ к файлу по id. Требуется JWT. Возможная реализация: 302 redirect на реальный URL файла или выдача контента файла.

Security
bearerAuth or jwtCookie
Path
idstringrequired

Идентификатор файла

curl -i -X GET \
  'https://felmee.com/file/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Контент файла (если сервер отдаёт файл напрямую)

Bodyapplication/octet-stream
string(binary)
Response
No content