post

Запросы к API

Чтобы сделать запрос к API, необходимо отправить POST запрос с указанием соответствующих параметров по адресу: https://adm.tools/api.php

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

Параметры

Параметр Обязательный Тип Описание
auth_login Да String логин учетной записи пользователя
auth_token Да String специальный токен доступа к API, который можно получить в разделе управление доступом
class Да String имя класса операции
method Да String имя операции
format Нет String Формат ответа на запрос, может принимать значения json или xml.
По-умолчанию установлено формат ответа JSON.

Как выполнить POST запрос средствами PHP?

$fields = array(
    'auth_login' => '<логин_вашей_учетной_записи>',
    'auth_token' => '<ваш_токен_доступа>',
    'class' => 'dns_domain',
    'method' => 'check',
    'stack' => array('adm.tools')  
);
$ch = curl_init('https://adm.tools/api.php');
curl_setopt_array($ch, array(
    CURLOPT_POST => TRUE,
    CURLOPT_RETURNTRANSFER => TRUE,
    CURLOPT_HTTPHEADER => array('Content-Type: application/json'),
    CURLOPT_POSTFIELDS => json_encode($fields)
));
$response = curl_exec($ch);
curl_close($ch);

Ответ на POST запрос всегда возвращается в кодировке UTF-8. Может быть возвращен в формате JSON или XML. В рамках документации рассматриваются только примеры в формате JSON.

Ответ всегда содержит поле status, которое может принимать значения error или success.

  • error: означает, что при попытке выполнить запрос произошла ошибка. При этом детальное описание ошибки будет возвращено в поле message.
    {"status":"error","message":"Почтовый ящик с именем test уже существует."}
    
  • success: запрос выполнен успешно. При этом, в зависимости от выполненной операции, сервер может возвратить дополнительные данные в поле data.
    {"status":"success","data":"219493"}
    
  • post.txt
  • Последние изменения: 6 месяц (-ев) назад
  • — rudenko