DMP API

https://pix.terratraf.com/api/

Адрес сервиса API: https://pix.terratraf.com/api/

API PIX основана на использовании протокола JSON-RPC 2.0. Подробнее о спецификации протокола можете прочитать в официальных источниках.

Авторизация

📘

Авторизация

Для получения токена авторизации обратитесь к администратору.

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

cURL

curl -H "Authorization: ..."

В значении заголовка указать сочетание строк Bearer + Токен. Например, если у вас есть токен: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9, то заголовок будет выглядеть так:

cURL

curl -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"

Пример использования токена при вызове метода:

cURL

curl -H "Authorization: Bearer TOKEN_XXX" -X POST -d '
{
  "jsonrpc": "2.0", 
  "method":"name_method",
  "params":{}, 
  "id": 1
}' "https://pix.terratraf.com/api/"

Получение списка аудиторий

Метод auditory.getList возвращает список существующих аудиторий.

Формат запроса:

cURL

curl -H "Authorization: Bearer TOKEN_XXX" -X POST -d '{
    "jsonrpc": "2.0", 
    "method":"auditory.getList", 
    "params":{}, 
    "id": 1
  }' "API_URL"

Формат ответа:

JSON

{
    "jsonrpc":"2.0",
    "result":[
      {
        "id":"mwtN0C72jOUO4qxGsk2DJiZ6c0TeG7J6",
        "name":"qwerty",
        "type":"id",
        "status":"pending"
      }
    ],
    "id":1
}

В ответе в "result" возвращается список объектов, где каждый объект имеет следующую структуру:

Название	Описание	Тип	Значение
id	Внутренний идентификатор аудитории	string
name	Название аудитории	string
type	Тип аудитории	string	Возможные значения: id, email, phone
status	Статус аудитории	string	Возможные значения: pending, processed, issue

Добавление новой аудитории

Метод auditory.add позволяет добавить аудиторию.

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

Название	Описание	Тип	Значение
name	Название аудитории	string
type	Тип	string	Возможные значения: id, email, phone

Формат запроса:

cURL

curl -H "Authorization: Bearer TOKEN_XXX" -X POST -d '{
    "jsonrpc": "2.0", 
    "method":"auditory.add", 
    "params":{"name": "test", "type": "id"}, 
    "id": 1
}' "API_URL"

Формат ответа:

JSON

{
    "jsonrpc":"2.0",
    "result": "mwtN0C36jOUO4qxGsk2DJiZ6c1TeG7J6"
}

В ответе возвращается идентификатор добавленной аудитории.

Загрузка файлов

• Запросы по загрузке файлов должны отправляться на адрес https://pix.terratraf.com/api/content/
• Запрос должен содержать токен авторизации.
• Запрос должен иметь тип multipart/form-data.

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

Название	Тип	Описание
file	resource	поле содержащее отправляемый файл

Ограничения на загрузку файлов:

• формата txt, csv, tsv
• размер файла не должен превышать 1мб

Формат запроса:

cURL

curl -X POST  
  -H "Authorization: Bearer TOKEN_XXX"
  -H "Content-Type: multipart/form-data" 
  -F "file=@/home/user/doc/doc.txt" 
  "https://pix.terratraf.com/api/content/"

Формат ответа:

JSON

{
  "result":{
      "src":"\/var\/tmp\/e18b8d37077b5407a228a5dc09d3f285.txt",
      "name":"e18b8d37077b5407a228a5dc09d3f285.txt",
      "extension":"txt",
      "size":75302,
      "type":"text\/plain"
  }
}

В случае успешной загрузки будет возвращен объект result, содержащий параметры загруженного файла:

• src - путь к файлу,
• name - название файла. Файл имеет длинное уникальное название, чтобы исключить проблему перезаписи файлов с одинаковым названием.
• extension - расширение,
• size - размер,
• type - тип файла.

В случае ошибки ответ будет иметь вид:

JSON

{
  "error":{
    "code":0,
    "message":"The file extension jpg is not allowed"
  }
}

Коды ошибок соответствуют списку кодов, подробнее смотрите в разделе ниже.

Загрузить файл в аудиторию

Метод auditory.upload позволяет загрузить файл в указанную в запросе аудиторию.

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

Название	Описание	Тип	Значение
auditory	Идентификатор аудитории	string
file	Объект файла	object	Объект из result метода загрузки файлов

Формат запроса:

cURL

curl -H "Authorization: Bearer TOKEN_XXX" -X POST -d '{
    "jsonrpc": "2.0", 
    "method":"auditory.upload", 
    "params":{
        "auditory": "mwtN0C72jOUO4qxGsk2DJiZ6c0TeG7J6", 
        "file": {
          "src":"XXX.txt",
          "name":"XXX.txt",
          "extension":"txt",
          "size":75302,
          "type":"text\/plain"
        }
    }, 
    "id": 1
}' "API_URL"

Формат ответа:

JSON

{
    "jsonrpc":"2.0",
    "result": true
}

Коды ошибок

Код	Описание
-32768 по -32000	Ошибки json-rpc2. Смотрите спецификацию в официальных источниках.
0	Неопределенная внутренняя ошибка.
1	Неопределенная внутренняя ошибка.
100	Один из необходимых параметров был не передан или неверен. Проверьте список требуемых параметров и их формат на странице с описанием метода
403	Доступ запрещен (недостаточно прав)
404	Элемент не найден