Перейти к основному содержимому

Импорт пользователей

  1. Создаём сущность файла

    Загрузите файл на сервер как показано в документации и получите объект FILESYSTEM_RES

    POST https://example.sinica.ru/api/files

    Документация по api

    Request Body

    {
    "key": "{FILESYSTEM_RES.data.key}",
    "name": "Название файла",
    "type": "text/csv"
    }

    Далее этот объект будет называться FILE_RES

  2. Создаём сущность импорта

    POST https://example.sinica.ru/api/imports

    Документация по api

    Request Body

    {
    "status": "pending",
    "type": "members"
    }

    Response Body

    {
    "data": {
    "id": 1, // Псевдоним – IMPORT_ID
    "space_id": 1,
    "type": "members",
    "status": "pending",
    "started_at": null,
    "ended_at": null,
    "result": null,
    "created_at": "2024-04-07T21:17:48.000000Z",
    "updated_at": "2024-04-07T21:17:50.000000Z",
    "meta_fields": null,
    "file_id": "{FILE_RES.data.id}"
    }
    }

    Далее этот объект будет называться IMPORT_RES

  3. Запускаем импорт

    PUT https://example.sinica.ru/api/imports/{IMPORT_ID}

    Документация по api

    Request Body

    {
    "status": "to_process"
    }
  4. Дожидаемся смены IMPORT_RES.data.status на processed

    GET https://example.sinica.ru/api/imports/{IMPORT_ID}

    Документация по api

    Response Body

    {
    "data": {
    "id":1,
    "space_id":1,
    "type":"members",
    "status":"processed",
    "started_at":"2024-04-07T21:17:50.000000Z",
    "ended_at":"2024-04-07T21:17:50.000000Z",
    "result":[
    {"message":"Иванов Иван (ivan@ivan.com) создан","operation":"create"},
    {"message":"Романов Роман (ivan1@ivan.com) создан","operation":"create"},
    {"message":"Кириллов Кирилл (ivan2@ivan.com) создан","operation":"create"}
    ],
    "created_at":"2024-04-07T21:17:48.000000Z",
    "updated_at":"2024-04-07T21:17:50.000000Z",
    "meta_fields":[],
    "file_id": "{FILE_RES.data.id}"
    }
    }

    в IMPORT_RES.data.result будет содержаться информация о результате импорта