Создание документа с открытым доступом

Метод Create free access document используется для создания нового документа реселлера с открытым доступом.

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

  • Роль и уровень доступа менеджера, от которых зависит доступность метода.
  • Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

POST {base_url}/api/v3/resellers/{reseller_id}/free_access_documents

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

X-Api-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform
reseller_idpathnumberОбязательныйID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
fileformstringОбязательный

Документ в кодировке base64 с указанием MIME-типа данных (см. Список MIME-типов). Поддерживаются следующие форматы файлов:

  • .JPG.
  • .JPEG.
  • .PNG.
  • .GIF.
  • .PDF.

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

Формат данных:

data:<MIME-тип данных>;base64,'содержимое в кодировке base64'

nameformstringОбязательныйНазвание документа

Модель ответа

Название

Тип данных

Описание

dataobjectДанные ответа


id

string

ID документа в платформе

typestringТип данных

attributesobjectИнформация о документе


created_at

string

Дата и время создания документа


updated_at

string

Дата и время последнего обновления документа


namestringНазвание документа


urlstringСсылка на документ в файловом хранилище

Ошибки

Метод возвращает ответ со статусом 500 Internal Server Error, если в запросе неверно указан аргумент file:

  • Отсутствует запятая перед содержимым файла.
  • Не удается установить MIME-тип ни по содержимому файла, ни указанному типу.

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

POST /api/v3/resellers/1/free_access_documents
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
{
    "file": "data:application/pdf;base64,'SSBob2xkIHRoZSBwb3NpdGlvbiBvZiBhIHFhIGVuZ2luZWVyLiBRQSBlbmdpbmVlciByZXNwb25zaWJpbGl0aWVzIGluY2x1ZGUgZGVzaWduaW5nIGFuZCBpbXBsZW1lbnRpbmcgdGVzdHMsIGRlYnVnZ2luZyBhbmQgZGVmaW5pbmcgY29ycmVjdGl2ZSBhY3Rpb25zLiBJIGFsc28gcmV2aWV3IHN5c3RlbSByZXF1aXJlbWVudHMgYW5kIHRyYWNrIHF1YWxpdHkgYXNzdXJhbmNlIG1ldHJpY3MgKGUuZy4gZGVmZWN0IGRlbnNpdGllcyBhbmQgb3BlbiBkZWZlY3QgY291bnRzLikgVGhlIFFBIHRlY2huaWNpYW4gcm9sZSBwbGF5cyBhbiBpbXBvcnRhbnQgcGFydCBpbiBvdXIgY29tcGFueeKAmXMgcHJvZHVjdCBkZXZlbG9wbWVudCBwcm9jZXNzLg=='",
    "name": "1.pdf"
}

Пример ответа

{
    "data": {
        "id": "56",
        "type": "free_access_documents",
        "attributes": {
            "created_at": "2020-10-09T16:49:19.699819+0300",
            "updated_at": "2020-10-09T16:49:19.699819+0300",
            "name": "1.pdf",
            "url": "https://storage.test.activeplatform.com/public/free_access_documents/9f3aba1ba07673314b1d1d5872688e11.pdf"
        }
    }
}