Методы API

Список методов

Генерация отчетов

Поставить отчет в очередь на генерацию по госномеру или VIN

Проверить состояние отчета

Получение результата генерации (ссылка на отчет)

Ключ доступа к API

Генерация отчета Состояние отчета Результат генерации

Отправить

Поставить отчет в очередь на генерацию по госномеру или VIN:

key

Ключ доступа к API

phone

телефон

Для получения отчета необходимо выполнить три действия:
1. Поставить отчет в очередь на генерацию (при этом Вы получите идентификатор отчета).
2. Используя полученный идентификатор отчета, необходимо с некоторым интервалом выполнять запросы для получения текущего состояния отчета. Когда генерация будет завершена, заявка получит соответствующий статус.
3. Используя полученный идентификатор отчета, необходимо получить ссылку на готовый отчет.

GET

https://data.tronk.info/reportphone.ashx?key=APIKEY&mode=setqueue&phone=79990000111

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

PHP

Python

                        
// Входные данные
$url = "https://data.tronk.info/reportphone.ashx";
$request_params = array(
    "key" => "867983b5-d66d-44d7-b440-5bd00b0b8203",
    "mode" => "setqueue",
    "phone" => "79990000111"
);

$get_params = http_build_query($request_params);

// Запрос к серверу
$response = file_get_contents($url."?".$get_params);
// Преобразование ответа
$result = json_decode($response);

                        
import requests

url = "https://data.tronk.info/reportphone.ashx"

# входные данные
params = {
    "key": "867983b5-d66d-44d7-b440-5bd00b0b8203",
    "mode": "setqueue",
    "phone": "79990000111",
}

# отправка запроса
response = requests.post(
    url=url,
    params=params,
)

# преобразование ответа к словарю
data = response.json()

                        
using Newtonsoft.Json;
class Program
{
    static async Task Main(string[] args)
    {
        string end_point = "https://data.tronk.info/reportphone.ashx";
        Dictionary dict_params = new()
        {
            { "key", "867983b5-d66d-44d7-b440-5bd00b0b8203" },
            { "mode", "setqueue" },
            { "phone", "79990000111" },
        };

        string url_params = string.Join("&", dict_params.Select(kvp => $"{kvp.Key}={kvp.Value}"));
        string url = $"{end_point}?{url_params}";

        HttpClient client = new();
        string response_body = await client.GetAsync(url).Result.Content.ReadAsStringAsync();

        var result = JsonConvert.DeserializeObject(response_body);
    }
}

Результат вызова метода:

Описание возвращаемого JSON

start DateTime

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

end DateTime

Дата и время окончания запроса

phone String

Телефон, по которому выполняется генерация отчета

error Boolean

Признак ошибки

status Int

Статус выполнения операции

id Int

ID задачи

startgeneration DateTime

Дата и время начала генерации отчета

msg Int

Сообщение

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

Закончился доступ или запросы (Проверить доступ)

Описание возвращаемого JSON

start DateTime

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

end DateTime

Дата и время окончания запроса

phone String

Телефон, по которому выполняется генерация отчета

error Boolean

Признак ошибки в запросе, имеет значение true в случае ошибки и null в случае её отсутствия

error_msg String

Сообщение с описанием ошибки

Проверить состояние отчета:

key

Ключ доступа к API

идентификатор отчета

GET

https://data.tronk.info/reportphone.ashx?key=XXXXXXXXXXX&mode=checkqueue&id=123

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

PHP

Python

                        
// Входные данные
$url = "https://data.tronk.info/reportphone.ashx";
$request_params = array(
    "key" => "867983b5-d66d-44d7-b440-5bd00b0b8203",
    "mode" => "checkqueue",
    "id" => 123
);

$get_params = http_build_query($request_params);

// Запрос к серверу
$response = file_get_contents($url."?".$get_params);
// Преобразование ответа
$result = json_decode($response);

                        
import requests

url = "https://data.tronk.info/reportphone.ashx"

# входные данные
params = {
    "key": "867983b5-d66d-44d7-b440-5bd00b0b8203",
    "mode": "checkqueue",
    "id": 123,
}

# отправка запроса
response = requests.post(
    url=url,
    params=params,
)

# преобразование ответа к словарю
data = response.json()

                        
using Newtonsoft.Json;
class Program
{
    static async Task Main(string[] args)
    {
        string end_point = "https://data.tronk.info/reportphone.ashx";
        Dictionary dict_params = new()
        {
            { "key", "867983b5-d66d-44d7-b440-5bd00b0b8203" },
            { "mode", "checkqueue" },
            { "id", 123 },
        };

        string url_params = string.Join("&", dict_params.Select(kvp => $"{kvp.Key}={kvp.Value}"));
        string url = $"{end_point}?{url_params}";

        HttpClient client = new();
        string response_body = await client.GetAsync(url).Result.Content.ReadAsStringAsync();

        var result = JsonConvert.DeserializeObject(response_body);
    }
}

Результат вызова метода:

Отчет еще не сгенерирован

Отчет успешно сгенерирован

Описание возвращаемого JSON

start DateTime

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

end DateTime

Дата и время окончания запроса

error Boolean

Признак ошибки

status Int

Статус выполнения операции

id Int

ID задачи

startgeneration DateTime

Дата и время начала генерации отчета

endgeneration DateTime

Дата и время завершения генерации отчета

msg String

Сообщение

resultJson String

строка с JSON отчета

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

Закончился доступ или запросы (Проверить доступ)

Описание возвращаемого JSON

start DateTime

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

end DateTime

Дата и время окончания запроса

vin String

VIN номер по которому выполняется генерация отчета

gosnumber String

Госномер по которому выполняется генерация отчета

error Boolean

Признак ошибки в запросе, имеет значение true в случае ошибки и null в случае её отсутствия

error_msg String

Сообщение с описанием ошибки

Получение результата генерации:

key

Ключ доступа к API

идентификатор отчета

GET

https://data.tronk.info/reportphone.ashx?key=XXXXXXXXXXX&mode=getresult&id=123

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

PHP

Python

                        
// Входные данные
$url = "https://data.tronk.info/reportphone.ashx";
$request_params = array(
    "key" => "867983b5-d66d-44d7-b440-5bd00b0b8203",
    "mode" => "getresult",
    "id" => 123
);

$get_params = http_build_query($request_params);

// Запрос к серверу
$response = file_get_contents($url."?".$get_params);
// Преобразование ответа
$result = json_decode($response);

                        
import requests

url = "https://data.tronk.info/reportphone.ashx"

# входные данные
params = {
    "key": "867983b5-d66d-44d7-b440-5bd00b0b8203",
    "mode": "getresult",
    "id": 123,
}

# отправка запроса
response = requests.post(
    url=url,
    params=params,
)

# преобразование ответа к словарю
data = response.json()

                        
using Newtonsoft.Json;
class Program
{
    static async Task Main(string[] args)
    {
        string end_point = "https://data.tronk.info/reportphone.ashx";
        Dictionary dict_params = new()
        {
            { "key", "867983b5-d66d-44d7-b440-5bd00b0b8203" },
            { "mode", "getresult" },
            { "id", 123 },
        };

        string url_params = string.Join("&", dict_params.Select(kvp => $"{kvp.Key}={kvp.Value}"));
        string url = $"{end_point}?{url_params}";

        HttpClient client = new();
        string response_body = await client.GetAsync(url).Result.Content.ReadAsStringAsync();

        var result = JsonConvert.DeserializeObject(response_body);
    }
}

Результат вызова метода:

Описание возвращаемого JSON

start DateTime

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

end DateTime

Дата и время окончания запроса

error Boolean

Признак ошибки

status Int

Статус выполнения операции

id Int

ID задачи

url String

Ссылка на отчет

startgeneration DateTime

Дата и время начала генерации отчета

endgeneration DateTime

Дата и время завершения генерации отчета

msg Int

Сообщение

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

Закончился доступ или запросы (Проверить доступ)

Описание возвращаемого JSON

start DateTime

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

end DateTime

Дата и время окончания запроса

vin String

VIN номер по которому выполняется генерация отчета

gosnumber String

Госномер по которому выполняется генерация отчета

error Boolean

Признак ошибки в запросе, имеет значение true в случае ошибки и null в случае её отсутствия

error_msg String

Сообщение с описанием ошибки

Оставьте заявку для получения консультации

Имя

Компания

Телефон

E-mail

Проявленый интерес

Согласен с офертой

или

Задать вопрос в Telegram