Files

На этой странице мы подробно рассмотрим различные конечные точки платежей, которые вы можете использовать для программного управления файлами.

The files model

Модель платежей содержит всю информацию о ваших платежах, такую как: дата платежа, сумма платежа, номер счёта и т.д.

Свойства

Name
id
Type
integer
Description
Первичный ключ, уникальное поле.
Name
files
Type
array
Description
Файлы.
Name
folders
Type
array
Description
Папки.
Name
delete
Type
boolean
Description
Есть ли права на удаление файла.
Name
update
Type
boolean
Description
Есть ли права на изменение файла.
Name
read
Type
boolean
Description
Есть ли права на просмотр файла.
Name
time
Type
timestamp
Description
Дата и время создания папки.
Name
lastModifiedUser
Type
string
Description
Пользователь внесший последние изменения.
Name
name
Type
string
Description
Наименование папки.
Name
parentFolder
Type
integer
Description
Родительская папка.

POST/upload_file

Upload a file

Эта конечная точка позволяет вам загружать файлы к текущему продукту.

Обязательные атрибуты

Name
public_key
Type
string
Description
API key в GET-параметре
Name
body
Type
string
Description
Тело запроса

Request

POST

/upload_file

curl -X POST "https://fileserver.aiins.online/upload_file?public_key={API key}"
  -H "Authorization: JWT {token}" \
  -H "Accept: application/json" \
  -d 'body'

Payload

{
    "file": binary,
    "folderId": "5779"
}

POST/download_zip

Download a zip file

Эта конечная точка позволяет вам скачивать ZIP-архив.

Обязательные атрибуты

Name
public_key
Type
string
Description
API key в GET-параметре
Name
body
Type
string
Description
Тело запроса

Request

POST

/download_zip

curl -X POST "https://fileserver.aiins.online/download_zip?public_key={API key}"
  -H "Authorization: JWT {token}" \
  -H "Accept: application/json" \
  -d 'body'

Payload

{
    "folder_id": [4312, 4313],
    "files_id": [4293]
}

GET/entity/share/product/:productId

Retrieve a files

Обратите внимание, что идентификтором для получия файлов является ID продукта

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

Обязательные атрибуты

Name
public_key
Type
string
Description
API key в GET-параметре
Name
productId
Type
integer
Description
ID договора

Request

GET

/entity/share/product/:productId

curl -G https://fileserver.aiins.online/entity/share/product/4608/
  -H "Authorization: JWT {token}" \
  -H "Accept: application/json"

Response

{
    "lastModifiedUser": "adept",
    "time": "2022-07-18T21:09:34.495154Z",
    "idInRightsServer": 4608,
    "read": true,
    "update": true,
    "delete": true,
    "subfolder": [],
    "files": [
        {
            "time": "2023-10-30T14:29:01.460117Z",
            "read": true,
            "update": true,
            "delete": true,
            "timeUpdate": "2023-10-30T14:29:01.460134Z",
            "mediaType": "application/pdf",
            "isLabel": false,
            "id": 4293,
            "name": "СТС.pdf",
            "size": "2.96 Kb"
        }
    ],
    "productFolder": true,
    "id": 5779,
    "name": "1006766363TL",
    "parentFolder": 3733
}

GET/download_file/:id

Download a file

Эта конечная точка позволяет вам скачать файл. Обратитесь к списку вверху этой страницы, чтобы узнать, какие свойства включены в файлы.

Обязательные атрибуты

Name
public_key
Type
string
Description
API key в GET-параметре
Name
id
Type
integer
Description
ID файла

Request

GET

/download_file/:id

curl -G https://fileserver.aiins.online/download_file/4292/
  -H "Authorization: JWT {token}" \
  -H "Accept: application/json"

Response

{
    "name": "СТС.pdf",
    "url": "https://minio-server.aiins.online/service-storage/9cbf6307-6a9a-4f64-81b9-b5a8c852b86e.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=adeptcontracts%2F20231030%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20231030T145250Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=8f4ca94d790da509a625f403cc086a5deed5294cffa6a8e7dab3beaec068473a"
}

DELETE.move_to_trash

Delete a file

Эта конечная точка позволяет вам удалять файлы.

Обязательные атрибуты

Name
public_key
Type
string
Description
API key в GET-параметре
Name
body
Type
integer
Description
Тело запроса

Request

DELETE

/move_to_trash

curl -X DELETE "https://fileserver.aiins.online/move_to_trash?public_key={API key}"
  -H "Authorization: JWT {token}" \
  -H "Accept: application/json"
  -d 'body'

Payload

{
    "folder_id": [],
    "files_id": [4293]
}