Выгрузка профилей в файл

Описание

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

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

Шаг 1. Выгрузка данных в файл

URL-адрес

Метод: POST

https://example.com/api/v1.1/profiles/get_all

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API-токен
source_type	string	"database" "segment"	Да	Тип источника данных
source_id	int	1	Да	Идентификатор источника данных
file_format	string	"csv"	Нет	Формат файла для экспорта. По умолчанию - csv.
custom_request	JSON object	{"occupation":"doctor"}	Нет	Поля профиля для уточнения поиска

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

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "source_type": "database",
    "source_id": 1,
    "file_format": "csv"
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <source_type>database</source_type>
  <source_id>1</source_id>
  <file_format>csv</file_format>
</xml>

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

JSON

{
    "data": {
        "task_id": "task_b2f9fd6a-2499-4a63-b592-f15d4e3b69c5"
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <task_id>task_b2f9fd6a-2499-4a63-b592-f15d4e3b69c5</task_id>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
task_id	string	Идентификатор задания на экспорт
error	int	Код ошибки
error_text	string	Текст ошибки

Шаг 2. Проверка статуса экспорта и получение ссылки

URL-адрес

Метод: POST

https://example.com/api/v1.1/tasks/status

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API-токен
task_id	string	"task_b2f9fk6a-2479-4a63-b592-f15d4e3b69c5"	Да	Идентификатор задания

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

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "task_id": "task_b2f9fk6a-2479-4a63-b592-f15d4e3b69c5"     
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <task_id>task_b2f9fk6a-2479-4a63-b592-f15d4e3b69c5</task_id>
</xml>

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

JSON

{
    "data": {
        "status": "success",
        "progress": 100,
        "result": {
            "source_id": 1,
            "total": 10,
            "type": "database",
            "urls": [
                "/api/download/6b248de2-39b9-4715-9720-5f4e23f4a296/1_database_export.csv"
            ]
        }
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
<data>
    <status>success</status>
    <progress>100</progress>
    <result>
      <source_id>1</source_id>
      <total>10</total>
      <type>database</type>
      <urls>/api/download/6b248de2-39b9-4715-9720-5f4e23f4a296/1_database_export.csv</urls>
    </result>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
status	string	Статус задания
progress	int	Прогресс выполнения
total	int	Количество профилей
urls	array	Ссылка на скачивание
error	int	Код ошибки
error_text	string	Текст ошибки

Шаг 3. Загрузка файла

URL-адрес

Ссылка на загрузку файла выглядит подобным образом:

https://example.com/api/download/6b248de2-33b9-4715-9720-5f7e23f4a296/1_database_export.csv?token=abcdefghijklmnqrstuvwxyz, где:

• https://example.com — ссылка на панель управления платформой
• api/download/6b248de2-33b9-4715-9720-5f7e23f4a296/1_database_export.csv — ссылка из параметра urls прошлого запроса
• ?token=abcdefghijklmnqrstuvwxyz — API-токен пользователя (после знака равенства).

Для загрузки файла с профилями необходимо либо открыть получившуюся ссылку в браузере, либо отправить пустой GET запрос с указанием данной ссылки в URL.