# Список доменов `GET /domains` **operationId:** `listDomains` Требуемые scopes: domains.read. Возвращает локальные записи только своего провайдера в окружении ключа; сортировка id по убыванию. GET не обращается к реестру. Soft-deleted домены и записи под глобальным migration hold не возвращаются. Фильтры точного совпадения; registry_status и sort не поддерживаются. per_page приводится к integer и ограничивается диапазоном 1..100 (по умолчанию 25). Передавайте непрозрачный cursor без изменений; отсутствие next_cursor означает конец списка. Лимит общий для всех запросов одного API-ключа (rate_limit_per_minute, значение по умолчанию при выдаче ключа 120, индивидуальное значение может отличаться). Окно счётчика 60 секунд. Учитывайте X-RateLimit-Limit и X-RateLimit-Remaining; при 429 дождитесь Retry-After секунд и добавьте jitter. Polling и повторы также расходуют лимит; лимиты реестра независимы. **Scopes:** `domains.read` ## Параметры ### cursor Расположение: `query`. Необязательный. Непрозрачное значение meta.next_cursor. На первой странице не передаётся; не конструируйте вручную. | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | string | Да | | | ### per_page Расположение: `query`. Необязательный. Рекомендуется 1..100, по умолчанию 25. Реализация приводит к integer и ограничивает 1..100, не возвращает 422 за выход из диапазона. | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | integer | Да | minimum: 1; maximum: 100; default: 25 | | **Пример** ```json 25 ``` ### customer_uuid Расположение: `query`. Необязательный. Точное совпадение UUID клиента. Невалидный UUID не имеет отдельной валидации; передавайте корректный UUID. | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | string | Да | format: "uuid" | | ### external_id Расположение: `query`. Необязательный. Точное совпадение внешнего идентификатора домена. | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | string | Да | | | ### status Расположение: `query`. Необязательный. Локальный status, например active; не EPP status. | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | string | Да | | | ### registration_status Расположение: `query`. Необязательный. Локальный registration_status, например registered. | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | string | Да | | | ## Тело запроса Тело запроса отсутствует. ## Пример запроса ::: code-group ```bash [cURL] API_BASE_URL='https://api.b.websoft.kz/api/reseller/v1' : "${RESELLER_API_TOKEN:?Set RESELLER_API_TOKEN in your environment}" curl --request GET "$API_BASE_URL/domains?per_page=25" \ --connect-timeout 5 --max-time 20 --fail-with-body \ --header "Authorization: Bearer $RESELLER_API_TOKEN" \ --header 'Accept: application/json' ``` ```php [PHP 8+] 'GET', CURLOPT_HTTPHEADER => $headers, CURLOPT_RETURNTRANSFER => true, CURLOPT_FOLLOWLOCATION => false, CURLOPT_CONNECTTIMEOUT => 5, CURLOPT_TIMEOUT => 20, CURLOPT_SSL_VERIFYPEER => true, CURLOPT_SSL_VERIFYHOST => 2, CURLOPT_HEADERFUNCTION => static function (CurlHandle $curl, string $line) use (&$responseHeaders): int { if (str_starts_with($line, 'HTTP/')) { $responseHeaders = []; } elseif (str_contains($line, ':')) { [$name, $value] = explode(':', $line, 2); $responseHeaders[strtolower(trim($name))] = trim($value); } return strlen($line); }, ])) { throw new RuntimeException('Cannot configure cURL.'); } $raw = curl_exec($handle); if ($raw === false) { throw new RuntimeException('Transport failure; result may be unknown. cURL code: ' . curl_errno($handle)); } $status = (int) curl_getinfo($handle, CURLINFO_RESPONSE_CODE); } finally { unset($handle); } $requestId = $responseHeaders['x-request-id'] ?? null; $retryAfter = $responseHeaders['retry-after'] ?? null; $data = null; if ($raw !== '' && !in_array($status, [204, 205], true)) { try { $data = json_decode($raw, true, 512, JSON_THROW_ON_ERROR); } catch (JsonException $error) { if ($status >= 200 && $status < 300) { throw new RuntimeException('Unexpected non-JSON success response.', 0, $error); } } } if ($status < 200 || $status >= 300) { // Inspect $data['error']; queue 429 using $retryAfter, never create a new write key blindly. throw new RuntimeException('HTTP ' . $status . '; request_id=' . ($requestId ?? '-') . '; retry_after=' . ($retryAfter ?? '-')); } // $data contains the decoded response; 202 means accepted, not completed. echo 'HTTP ' . $status . PHP_EOL; ``` ```js [JavaScript / Node.js] // Node.js 22+; save as request.mjs. No third-party dependencies. function requiredEnv(name) { const value = process.env[name]; if (!value || /[\r\n]/u.test(value)) throw new Error('Set a valid environment variable: ' + name); return value; } const baseUrl = (process.env.API_BASE_URL || "https://api.b.websoft.kz/api/reseller/v1").replace(/\/$/u, ''); let path = "/domains"; const url = baseUrl + path + "?per_page=25"; const response = await fetch(url, { method: "GET", redirect: 'manual', signal: AbortSignal.timeout(20_000), headers: { Authorization: 'Bearer ' + requiredEnv('RESELLER_API_TOKEN'), Accept: 'application/json', }, }); const requestId = response.headers.get('x-request-id'); const retryAfter = response.headers.get('retry-after'); const raw = await response.text(); let data = null; if (raw && ![204, 205].includes(response.status)) { try { data = JSON.parse(raw); } catch (cause) { if (response.ok) throw new Error('Unexpected non-JSON success response.', { cause }); } } if (!response.ok) { // Inspect data?.error; schedule 429 using retryAfter. Do not generate another write key. throw new Error('HTTP ' + response.status + '; request_id=' + requestId + '; retry_after=' + retryAfter); } // A timeout may have an unknown result. No automatic mutation retry in this example. // data contains the response; 202 means accepted, not completed. console.log('HTTP', response.status); ``` ```python [Python] # Python 3.10+; standard library only. import json import os from urllib.error import HTTPError from urllib.parse import quote from urllib.request import HTTPRedirectHandler, Request, build_opener def required_env(name): value = os.environ.get(name, "") if not value or "\r" in value or "\n" in value: raise RuntimeError("Set a valid environment variable: " + name) return value class NoRedirect(HTTPRedirectHandler): def redirect_request(self, req, fp, code, msg, headers, newurl): return None base_url = os.environ.get("API_BASE_URL", "https://api.b.websoft.kz/api/reseller/v1").rstrip("/") path = "/domains" url = base_url + path + "?per_page=25" headers = { "Authorization": "Bearer " + required_env("RESELLER_API_TOKEN"), "Accept": "application/json", } body = None request = Request(url, data=body, headers=headers, method="GET") opener = build_opener(NoRedirect()) try: response = opener.open(request, timeout=20) except HTTPError as error: response = error # HTTP failure still has a response body and headers. # Network/timeout exceptions propagate: a write may already have been accepted. with response: status = response.status request_id = response.headers.get("X-Request-ID") retry_after = response.headers.get("Retry-After") raw = response.read() data = None if raw and status not in (204, 205): try: data = json.loads(raw) except (ValueError, UnicodeDecodeError): if 200 <= status < 300: raise RuntimeError("Unexpected non-JSON success response.") if not 200 <= status < 300: # Inspect data['error']; schedule 429 with retry_after, keeping the same persisted key. raise RuntimeError(f"HTTP {status}; request_id={request_id}; retry_after={retry_after}") # data contains the response. Do not log secrets/PII; 202 is not completion. print("HTTP", status) ``` ```go [Go] // Go 1.22+; standard library only. Save as main.go and run: go run main.go package main import ( "encoding/json" "fmt" "io" "net/http" "os" "strings" "time" ) func requiredEnv(name string) string { value := os.Getenv(name) if value == "" || strings.ContainsAny(value, "\r\n") { panic("Set a valid environment variable: " + name) } return value } func main() { baseURL := os.Getenv("API_BASE_URL") if baseURL == "" { baseURL = "https://api.b.websoft.kz/api/reseller/v1" } path := "/domains" endpoint := strings.TrimRight(baseURL, "/") + path + "?per_page=25" request, err := http.NewRequest("GET", endpoint, nil) if err != nil { panic(err) } request.Header.Set("Authorization", "Bearer " + requiredEnv("RESELLER_API_TOKEN")) request.Header.Set("Accept", "application/json") client := &http.Client{ Timeout: 20 * time.Second, CheckRedirect: func(req *http.Request, via []*http.Request) error { return http.ErrUseLastResponse }, } response, err := client.Do(request) if err != nil { panic("Transport failure; operation result may be unknown") } defer response.Body.Close() raw, err := io.ReadAll(response.Body) if err != nil { panic("Response read failed; operation result may be unknown") } requestID := response.Header.Get("X-Request-ID") retryAfter := response.Header.Get("Retry-After") var data any if len(raw) > 0 && response.StatusCode != 204 && response.StatusCode != 205 { decoder := json.NewDecoder(strings.NewReader(string(raw))) decoder.UseNumber() // Preserve integer money/identifiers without float rounding. if err := decoder.Decode(&data); err != nil && response.StatusCode >= 200 && response.StatusCode < 300 { panic("Unexpected non-JSON success response") } } if response.StatusCode < 200 || response.StatusCode >= 300 { // Inspect data; schedule 429 using retryAfter. Never create a new key blindly. panic(fmt.Sprintf("HTTP %d; request_id=%s; retry_after=%s", response.StatusCode, requestID, retryAfter)) } // data holds the JSON value; 202 means accepted, not completed. Do not log secrets. fmt.Println("HTTP", response.StatusCode) } ``` ```java [Java] // Java 17+; standard library only. Save as RequestExample.java. // Run: java RequestExample.java import java.net.URI; import java.net.URLEncoder; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; import java.nio.charset.StandardCharsets; import java.time.Duration; public class RequestExample { private static String requiredEnv(String name) { String value = System.getenv(name); if (value == null || value.isEmpty() || value.contains("\r") || value.contains("\n")) { throw new IllegalStateException("Set a valid environment variable: " + name); } return value; } private static String envOr(String name, String fallback) { String value = System.getenv(name); return value == null || value.isEmpty() ? fallback : value; } public static void main(String[] args) throws Exception { String baseUrl = envOr("API_BASE_URL", "https://api.b.websoft.kz/api/reseller/v1").replaceAll("/+$", ""); String path = "/domains"; URI uri = URI.create(baseUrl + path + "?per_page=25"); HttpRequest request = HttpRequest.newBuilder(uri) .timeout(Duration.ofSeconds(20)) .header("Authorization", "Bearer " + requiredEnv("RESELLER_API_TOKEN")) .header("Accept", "application/json") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(5)) .followRedirects(HttpClient.Redirect.NEVER) .build(); // Reuse HttpClient in production. A timeout may mean an unknown write result. HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8)); int status = response.statusCode(); String requestId = response.headers().firstValue("X-Request-ID").orElse(""); String retryAfter = response.headers().firstValue("Retry-After").orElse(""); String responseBody = (status == 204 || status == 205) ? "" : response.body(); if (status < 200 || status >= 300) { // Decode responseBody with your JSON library; schedule 429 using retryAfter. throw new IllegalStateException("HTTP " + status + "; request_id=" + requestId + "; retry_after=" + retryAfter); } // Java SE has no JSON object mapper: pass responseBody to your project's JSON parser. // Do not parse an empty 204 body; 202 means accepted, not completed. System.out.println("HTTP " + status); } } ``` ```csharp [C# / .NET] // C# / .NET 8+ console app; standard library only. Save as Program.cs. using System; using System.Net.Http; using System.Text; using System.Text.Json; static string RequiredEnv(string name) { string? value = Environment.GetEnvironmentVariable(name); if (string.IsNullOrEmpty(value) || value.Contains('\r') || value.Contains('\n')) throw new InvalidOperationException("Set a valid environment variable: " + name); return value; } string baseUrl = (Environment.GetEnvironmentVariable("API_BASE_URL") ?? "https://api.b.websoft.kz/api/reseller/v1").TrimEnd('/'); string path = "/domains"; using var handler = new HttpClientHandler { AllowAutoRedirect = false }; using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(20) }; // Reuse HttpClient (or IHttpClientFactory) in production, not one client per request. using var request = new HttpRequestMessage(new HttpMethod("GET"), baseUrl + path + "?per_page=25"); request.Headers.Add("Authorization", "Bearer " + RequiredEnv("RESELLER_API_TOKEN")); request.Headers.Add("Accept", "application/json"); // Transport exceptions may have an unknown result; do not issue a new mutation automatically. using var response = await client.SendAsync(request); int status = (int)response.StatusCode; string requestId = response.Headers.TryGetValues("X-Request-ID", out var ids) ? string.Join(",", ids) : ""; string retryAfter = response.Headers.TryGetValues("Retry-After", out var delays) ? string.Join(",", delays) : ""; string raw = await response.Content.ReadAsStringAsync(); JsonElement? data = null; if (raw.Length > 0 && status != 204 && status != 205) { try { using var document = JsonDocument.Parse(raw); data = document.RootElement.Clone(); } catch (JsonException) { if (response.IsSuccessStatusCode) throw; } } if (!response.IsSuccessStatusCode) { // Inspect data; schedule 429 using retryAfter and preserve the same key/body. throw new HttpRequestException($"HTTP {status}; request_id={requestId}; retry_after={retryAfter}"); } // data contains JSON, or null for 204. HTTP 202 is not completion. Console.WriteLine($"HTTP {status}"); ``` ::: ## Ответы ### Условия ошибок и восстановление | HTTP | Код | Когда возникает | Что делать | | --- | --- | --- | --- | | 401 | `unauthenticated` | Нет действительного Bearer API-ключа. | Проверьте ключ, срок действия и окружение; не повторяйте бесконечно. | | 403 | `forbidden` | Нет требуемого scope, провайдер/ключ/доступ запрещён. | Проверьте настройки провайдера и scopes ключа. | | 429 | `rate_limit_exceeded` | Исчерпан общий лимит ключа. | Выждите Retry-After; повторы выполняйте с backoff и jitter. | | 500 | `internal_error` | Необработанный сбой инфраструктуры или внешнего драйвера. | Сохраните request_id. Для изменения сначала проверьте существующую задачу; не генерируйте новый ключ вслепую. Формат ответа reverse proxy может отличаться от API. | | 404 | `resource_not_found` | Reseller API глобально выключен конфигурацией. | Уточните доступность API и base URL у оператора. | ### HTTP 200 Успешное чтение или сохранение настройки. **Content-Type:** `application/json` | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | object | Да | required: ["data","links","meta"] | Схема: DomainListEnvelope | | `$.data` | array | Да | | Домены текущего провайдера и окружения, id по убыванию. | | `$.data[]` | object | Да | required: ["uuid","external_id","service_uuid","customer_uuid","domain_name","unicode_domain_name","punycode_domain_name","status","registration_status","registrar_operation_status","registry_status","verification_status","verification_registry_status","edu_license_status","hold_status","hold_reason","registered_at","expires_at","last_synced_at","zone","contacts","nameservers","created_at","updated_at"] | Схема: DomainRecord | | `$.data[].uuid` | string | Да | format: "uuid" | UUID домена; используйте в domainUuid. | | `$.data[].external_id` | string / null | Да | | Идентификатор услуги во внешнем биллинге; null для неназначенного. | | `$.data[].service_uuid` | string / null | Да | format: "uuid" | UUID услуги для GET /services/{serviceUuid}. | | `$.data[].customer_uuid` | string / null | Да | format: "uuid" | UUID плательщика. | | `$.data[].domain_name` | string | Да | maxLength: 253 | Полное доменное имя без схемы, пути, порта и завершающей точки. IDN допускается; сервер нормализует регистр и преобразует в Punycode UTS46. ASCII-представление не длиннее 253, каждая метка не длиннее 63 символов. example.kz в примерах не означает доступность для регистрации. Схема: DomainName | | `$.data[].unicode_domain_name` | string / null | Да | | Unicode-представление имени. | | `$.data[].punycode_domain_name` | string / null | Да | | ASCII/Punycode-представление имени. | | `$.data[].status` | string / null | Да | | Локальное состояние услуги: например active, pending, expired. Не статус EPP. | | `$.data[].registration_status` | string / null | Да | | Локальное состояние регистрации: например pending, registered, failed. | | `$.data[].registrar_operation_status` | string / null | Да | | Последний результат операции регистратора. | | `$.data[].registry_status` | string / null | Да | | Сводное состояние реестра; строка не ограничена enum и не является массивом EPP-статусов. | | `$.data[].verification_status` | string / null | Да | | Локальное состояние проверки владельца. | | `$.data[].verification_registry_status` | string / null | Да | | Состояние проверки владельца в реестре. | | `$.data[].edu_license_status` | string / null | Да | | Состояние образовательной лицензии для соответствующих зон. | | `$.data[].hold_status` | string / null | Да | | Локальное состояние блокировки. | | `$.data[].hold_reason` | string / null | Да | | Причина блокировки; может быть null. | | `$.data[].registered_at` | string / null | Да | format: "date-time" | Дата создания в реестре; используется для ограничения продления 24 часа. | | `$.data[].expires_at` | string / null | Да | format: "date-time" | Актуальное локальное время окончания; подтверждайте синхронизацией. | | `$.data[].last_synced_at` | string / null | Да | format: "date-time" | Последняя синхронизация с реестром. | | `$.data[].zone` | anyOf | Да | | Зона или null. | | `$.data[].zone (anyOf 1)` | object | Да | required: ["uuid","zone","display_name"] | | | `$.data[].zone (anyOf 1).uuid` | string | Да | format: "uuid" | UUID зоны для расчёта quote. | | `$.data[].zone (anyOf 1).zone` | string | Да | | Зона без ведущей точки. | | `$.data[].zone (anyOf 1).display_name` | string / null | Да | | Отображаемое название зоны. | | `$.data[].zone (anyOf 2)` | null | Да | | | | `$.data[].contacts` | object | Да | required: ["owner","admin","tech","billing"] | | | `$.data[].contacts.owner` | anyOf | Да | | Контакт роли owner или null. | | `$.data[].contacts.owner (anyOf 1)` | object | Да | required: ["uuid","type","status","first_name","last_name","middle_name","organization_name","email","phone","country_code","residence_country_code","city","region","address_line","postal_code","external_id_type","verification_status","is_locked_as_registrant","verified_at"] | Схема: DomainContactSnapshot | | `$.data[].contacts.owner (anyOf 1).uuid` | string | Да | format: "uuid" | UUID локального профиля контакта, не EPP contact handle. | | `$.data[].contacts.owner (anyOf 1).type` | string | Да | enum: "person", "organization" | Тип контакта профиля: person (физическое лицо) или organization (организация). Не путать с типом billing customer. | | `$.data[].contacts.owner (anyOf 1).status` | string | Да | | Состояние локального профиля, например active. | | `$.data[].contacts.owner (anyOf 1).first_name` | string / null | Да | | Имя. | | `$.data[].contacts.owner (anyOf 1).last_name` | string / null | Да | | Фамилия. | | `$.data[].contacts.owner (anyOf 1).middle_name` | string / null | Да | | Отчество. | | `$.data[].contacts.owner (anyOf 1).organization_name` | string / null | Да | | Название организации. | | `$.data[].contacts.owner (anyOf 1).email` | string / null | Да | format: "email" | Email. | | `$.data[].contacts.owner (anyOf 1).phone` | string / null | Да | | Телефон. | | `$.data[].contacts.owner (anyOf 1).country_code` | string / null | Да | | Код страны адреса. | | `$.data[].contacts.owner (anyOf 1).residence_country_code` | string / null | Да | | Код страны резидентства. | | `$.data[].contacts.owner (anyOf 1).city` | string / null | Да | | Город. | | `$.data[].contacts.owner (anyOf 1).region` | string / null | Да | | Регион. | | `$.data[].contacts.owner (anyOf 1).address_line` | string / null | Да | | Адрес. | | `$.data[].contacts.owner (anyOf 1).postal_code` | string / null | Да | | Почтовый индекс. | | `$.data[].contacts.owner (anyOf 1).external_id_type` | string / null | Да | | Тип документа, например IIN или BIN. Сам идентификатор этот ресурс не раскрывает. | | `$.data[].contacts.owner (anyOf 1).verification_status` | string / null | Да | | Состояние проверки контакта. | | `$.data[].contacts.owner (anyOf 1).is_locked_as_registrant` | boolean | Да | | Контакт заблокирован как подтверждённый владелец. | | `$.data[].contacts.owner (anyOf 1).verified_at` | string / null | Да | format: "date-time" | Время подтверждения или null. | | `$.data[].contacts.owner (anyOf 2)` | null | Да | | | | `$.data[].contacts.admin` | anyOf | Да | | Контакт роли admin или null. | | `$.data[].contacts.admin (anyOf 1)` | object | Да | required: ["uuid","type","status","first_name","last_name","middle_name","organization_name","email","phone","country_code","residence_country_code","city","region","address_line","postal_code","external_id_type","verification_status","is_locked_as_registrant","verified_at"] | Схема: DomainContactSnapshot | | `$.data[].contacts.admin (anyOf 1).uuid` | string | Да | format: "uuid" | UUID локального профиля контакта, не EPP contact handle. | | `$.data[].contacts.admin (anyOf 1).type` | string | Да | enum: "person", "organization" | Тип контакта профиля: person (физическое лицо) или organization (организация). Не путать с типом billing customer. | | `$.data[].contacts.admin (anyOf 1).status` | string | Да | | Состояние локального профиля, например active. | | `$.data[].contacts.admin (anyOf 1).first_name` | string / null | Да | | Имя. | | `$.data[].contacts.admin (anyOf 1).last_name` | string / null | Да | | Фамилия. | | `$.data[].contacts.admin (anyOf 1).middle_name` | string / null | Да | | Отчество. | | `$.data[].contacts.admin (anyOf 1).organization_name` | string / null | Да | | Название организации. | | `$.data[].contacts.admin (anyOf 1).email` | string / null | Да | format: "email" | Email. | | `$.data[].contacts.admin (anyOf 1).phone` | string / null | Да | | Телефон. | | `$.data[].contacts.admin (anyOf 1).country_code` | string / null | Да | | Код страны адреса. | | `$.data[].contacts.admin (anyOf 1).residence_country_code` | string / null | Да | | Код страны резидентства. | | `$.data[].contacts.admin (anyOf 1).city` | string / null | Да | | Город. | | `$.data[].contacts.admin (anyOf 1).region` | string / null | Да | | Регион. | | `$.data[].contacts.admin (anyOf 1).address_line` | string / null | Да | | Адрес. | | `$.data[].contacts.admin (anyOf 1).postal_code` | string / null | Да | | Почтовый индекс. | | `$.data[].contacts.admin (anyOf 1).external_id_type` | string / null | Да | | Тип документа, например IIN или BIN. Сам идентификатор этот ресурс не раскрывает. | | `$.data[].contacts.admin (anyOf 1).verification_status` | string / null | Да | | Состояние проверки контакта. | | `$.data[].contacts.admin (anyOf 1).is_locked_as_registrant` | boolean | Да | | Контакт заблокирован как подтверждённый владелец. | | `$.data[].contacts.admin (anyOf 1).verified_at` | string / null | Да | format: "date-time" | Время подтверждения или null. | | `$.data[].contacts.admin (anyOf 2)` | null | Да | | | | `$.data[].contacts.tech` | anyOf | Да | | Контакт роли tech или null. | | `$.data[].contacts.tech (anyOf 1)` | object | Да | required: ["uuid","type","status","first_name","last_name","middle_name","organization_name","email","phone","country_code","residence_country_code","city","region","address_line","postal_code","external_id_type","verification_status","is_locked_as_registrant","verified_at"] | Схема: DomainContactSnapshot | | `$.data[].contacts.tech (anyOf 1).uuid` | string | Да | format: "uuid" | UUID локального профиля контакта, не EPP contact handle. | | `$.data[].contacts.tech (anyOf 1).type` | string | Да | enum: "person", "organization" | Тип контакта профиля: person (физическое лицо) или organization (организация). Не путать с типом billing customer. | | `$.data[].contacts.tech (anyOf 1).status` | string | Да | | Состояние локального профиля, например active. | | `$.data[].contacts.tech (anyOf 1).first_name` | string / null | Да | | Имя. | | `$.data[].contacts.tech (anyOf 1).last_name` | string / null | Да | | Фамилия. | | `$.data[].contacts.tech (anyOf 1).middle_name` | string / null | Да | | Отчество. | | `$.data[].contacts.tech (anyOf 1).organization_name` | string / null | Да | | Название организации. | | `$.data[].contacts.tech (anyOf 1).email` | string / null | Да | format: "email" | Email. | | `$.data[].contacts.tech (anyOf 1).phone` | string / null | Да | | Телефон. | | `$.data[].contacts.tech (anyOf 1).country_code` | string / null | Да | | Код страны адреса. | | `$.data[].contacts.tech (anyOf 1).residence_country_code` | string / null | Да | | Код страны резидентства. | | `$.data[].contacts.tech (anyOf 1).city` | string / null | Да | | Город. | | `$.data[].contacts.tech (anyOf 1).region` | string / null | Да | | Регион. | | `$.data[].contacts.tech (anyOf 1).address_line` | string / null | Да | | Адрес. | | `$.data[].contacts.tech (anyOf 1).postal_code` | string / null | Да | | Почтовый индекс. | | `$.data[].contacts.tech (anyOf 1).external_id_type` | string / null | Да | | Тип документа, например IIN или BIN. Сам идентификатор этот ресурс не раскрывает. | | `$.data[].contacts.tech (anyOf 1).verification_status` | string / null | Да | | Состояние проверки контакта. | | `$.data[].contacts.tech (anyOf 1).is_locked_as_registrant` | boolean | Да | | Контакт заблокирован как подтверждённый владелец. | | `$.data[].contacts.tech (anyOf 1).verified_at` | string / null | Да | format: "date-time" | Время подтверждения или null. | | `$.data[].contacts.tech (anyOf 2)` | null | Да | | | | `$.data[].contacts.billing` | anyOf | Да | | Контакт роли billing или null. | | `$.data[].contacts.billing (anyOf 1)` | object | Да | required: ["uuid","type","status","first_name","last_name","middle_name","organization_name","email","phone","country_code","residence_country_code","city","region","address_line","postal_code","external_id_type","verification_status","is_locked_as_registrant","verified_at"] | Схема: DomainContactSnapshot | | `$.data[].contacts.billing (anyOf 1).uuid` | string | Да | format: "uuid" | UUID локального профиля контакта, не EPP contact handle. | | `$.data[].contacts.billing (anyOf 1).type` | string | Да | enum: "person", "organization" | Тип контакта профиля: person (физическое лицо) или organization (организация). Не путать с типом billing customer. | | `$.data[].contacts.billing (anyOf 1).status` | string | Да | | Состояние локального профиля, например active. | | `$.data[].contacts.billing (anyOf 1).first_name` | string / null | Да | | Имя. | | `$.data[].contacts.billing (anyOf 1).last_name` | string / null | Да | | Фамилия. | | `$.data[].contacts.billing (anyOf 1).middle_name` | string / null | Да | | Отчество. | | `$.data[].contacts.billing (anyOf 1).organization_name` | string / null | Да | | Название организации. | | `$.data[].contacts.billing (anyOf 1).email` | string / null | Да | format: "email" | Email. | | `$.data[].contacts.billing (anyOf 1).phone` | string / null | Да | | Телефон. | | `$.data[].contacts.billing (anyOf 1).country_code` | string / null | Да | | Код страны адреса. | | `$.data[].contacts.billing (anyOf 1).residence_country_code` | string / null | Да | | Код страны резидентства. | | `$.data[].contacts.billing (anyOf 1).city` | string / null | Да | | Город. | | `$.data[].contacts.billing (anyOf 1).region` | string / null | Да | | Регион. | | `$.data[].contacts.billing (anyOf 1).address_line` | string / null | Да | | Адрес. | | `$.data[].contacts.billing (anyOf 1).postal_code` | string / null | Да | | Почтовый индекс. | | `$.data[].contacts.billing (anyOf 1).external_id_type` | string / null | Да | | Тип документа, например IIN или BIN. Сам идентификатор этот ресурс не раскрывает. | | `$.data[].contacts.billing (anyOf 1).verification_status` | string / null | Да | | Состояние проверки контакта. | | `$.data[].contacts.billing (anyOf 1).is_locked_as_registrant` | boolean | Да | | Контакт заблокирован как подтверждённый владелец. | | `$.data[].contacts.billing (anyOf 1).verified_at` | string / null | Да | format: "date-time" | Время подтверждения или null. | | `$.data[].contacts.billing (anyOf 2)` | null | Да | | | | `$.data[].nameservers` | array | Да | | Текущие локальные NS; массив может быть пустым. | | `$.data[].nameservers[]` | object | Да | required: ["hostname","ipv4","ipv6"] | | | `$.data[].nameservers[].hostname` | string | Да | | Имя сервера. | | `$.data[].nameservers[].ipv4` | string / null | Да | format: "ipv4" | Glue IPv4. | | `$.data[].nameservers[].ipv6` | string / null | Да | format: "ipv6" | Glue IPv6. | | `$.data[].created_at` | string / null | Да | format: "date-time" | Создание локальной записи. | | `$.data[].updated_at` | string / null | Да | format: "date-time" | Последнее изменение локальной записи. | | `$.links` | object | Да | required: ["first","last","prev","next"] | Схема: DomainCursorLinks | | `$.links.first` | string / null | Да | | Для cursor pagination null. | | `$.links.last` | string / null | Да | | Для cursor pagination null. | | `$.links.prev` | string / null | Да | format: "uri" | URL предыдущей страницы либо null. | | `$.links.next` | string / null | Да | format: "uri" | URL следующей страницы либо null. | | `$.meta` | object | Да | required: ["path","per_page","next_cursor","prev_cursor"] | Схема: DomainCursorMeta | | `$.meta.path` | string | Да | format: "uri" | URL списка без cursor. | | `$.meta.per_page` | integer | Да | minimum: 1; maximum: 100 | Фактический размер страницы. | | `$.meta.next_cursor` | string / null | Да | | Непрозрачный cursor следующей страницы. | | `$.meta.prev_cursor` | string / null | Да | | Непрозрачный cursor предыдущей страницы. | #### Последняя страница с одним доменом (200) ```json { "data": [ { "uuid": "019a1234-1000-7000-8000-000000000001", "external_id": "crm-domain-1001", "service_uuid": "019a1234-1000-7000-8000-000000000005", "customer_uuid": "019a1234-1000-7000-8000-000000000002", "domain_name": "example.kz", "unicode_domain_name": "example.kz", "punycode_domain_name": "example.kz", "status": "active", "registration_status": "registered", "registrar_operation_status": "success", "registry_status": "ok", "verification_status": "pending", "verification_registry_status": null, "edu_license_status": null, "hold_status": "none", "hold_reason": null, "registered_at": "2026-10-01T08:00:00+00:00", "expires_at": "2027-10-01T08:00:00+00:00", "last_synced_at": "2026-10-05T08:00:00+00:00", "zone": { "uuid": "019a1234-1000-7000-8000-000000000004", "zone": "kz", "display_name": ".kz" }, "contacts": { "owner": { "uuid": "019a1234-1000-7000-8000-000000000003", "type": "person", "status": "active", "first_name": "Ivan", "last_name": "Petrov", "middle_name": null, "organization_name": null, "email": "owner@example.net", "phone": "+77000000000", "country_code": "KZ", "residence_country_code": "KZ", "city": "Almaty", "region": "Almaty", "address_line": "Example street 1", "postal_code": "050000", "external_id_type": "IIN", "verification_status": "pending", "is_locked_as_registrant": false, "verified_at": null }, "admin": { "uuid": "019a1234-1000-7000-8000-000000000003", "type": "person", "status": "active", "first_name": "Ivan", "last_name": "Petrov", "middle_name": null, "organization_name": null, "email": "owner@example.net", "phone": "+77000000000", "country_code": "KZ", "residence_country_code": "KZ", "city": "Almaty", "region": "Almaty", "address_line": "Example street 1", "postal_code": "050000", "external_id_type": "IIN", "verification_status": "pending", "is_locked_as_registrant": false, "verified_at": null }, "tech": { "uuid": "019a1234-1000-7000-8000-000000000003", "type": "person", "status": "active", "first_name": "Ivan", "last_name": "Petrov", "middle_name": null, "organization_name": null, "email": "owner@example.net", "phone": "+77000000000", "country_code": "KZ", "residence_country_code": "KZ", "city": "Almaty", "region": "Almaty", "address_line": "Example street 1", "postal_code": "050000", "external_id_type": "IIN", "verification_status": "pending", "is_locked_as_registrant": false, "verified_at": null }, "billing": { "uuid": "019a1234-1000-7000-8000-000000000003", "type": "person", "status": "active", "first_name": "Ivan", "last_name": "Petrov", "middle_name": null, "organization_name": null, "email": "owner@example.net", "phone": "+77000000000", "country_code": "KZ", "residence_country_code": "KZ", "city": "Almaty", "region": "Almaty", "address_line": "Example street 1", "postal_code": "050000", "external_id_type": "IIN", "verification_status": "pending", "is_locked_as_registrant": false, "verified_at": null } }, "nameservers": [ { "hostname": "ns1.example.net", "ipv4": null, "ipv6": null }, { "hostname": "ns2.example.net", "ipv4": null, "ipv6": null } ], "created_at": "2026-10-01T07:59:00+00:00", "updated_at": "2026-10-05T08:00:00+00:00" } ], "links": { "first": null, "last": null, "prev": null, "next": null }, "meta": { "path": "https://api.example.net/api/reseller/v1/domains", "per_page": 25, "next_cursor": null, "prev_cursor": null } } ``` #### Нет подходящих доменов (200) ```json { "data": [], "links": { "first": null, "last": null, "prev": null, "next": null }, "meta": { "path": "https://api.example.net/api/reseller/v1/domains", "per_page": 25, "next_cursor": null, "prev_cursor": null } } ``` ### HTTP 401 Отсутствует, неверен, отозван или просрочен Bearer-ключ. **Заголовок `X-Request-ID`**: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута. | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | string | Да | format: "uuid" | | **Content-Type:** `application/json` | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope | | `$.error` | object | Да | required: ["code","message","details","request_id"] | | | `$.error.code` | string | Да | | Машинный код; не извлекайте причину из message. | | `$.error.message` | string | Да | | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. | | `$.error.details` | oneOf | Да | | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. | | `$.error.details (oneOf 1)` | array | Да | maxItems: 0 | | | `$.error.details (oneOf 2)` | object | Да | | | | `$.error.details (oneOf 2).*` | array | Нет | | | | `$.error.details (oneOf 2).*[]` | string | Да | | | | `$.error.details (oneOf 3)` | object | Да | required: ["retry_after"]; Дополнительные поля запрещены | | | `$.error.details (oneOf 3).retry_after` | integer | Да | minimum: 0 | | | `$.error.request_id` | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. | #### default (401) ```json { "error": { "code": "unauthenticated", "message": "API credential is missing or invalid.", "details": [], "request_id": "11111111-1111-4111-8111-111111111111" } } ``` ### HTTP 403 Нет scope, IP не разрешён, тариф/режим/статус реселлера запрещает действие либо test-ключ обращается к live-only ресурсу. **Заголовок `X-Request-ID`**: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута. | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | string | Да | format: "uuid" | | **Content-Type:** `application/json` | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope | | `$.error` | object | Да | required: ["code","message","details","request_id"] | | | `$.error.code` | string | Да | | Машинный код; не извлекайте причину из message. | | `$.error.message` | string | Да | | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. | | `$.error.details` | oneOf | Да | | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. | | `$.error.details (oneOf 1)` | array | Да | maxItems: 0 | | | `$.error.details (oneOf 2)` | object | Да | | | | `$.error.details (oneOf 2).*` | array | Нет | | | | `$.error.details (oneOf 2).*[]` | string | Да | | | | `$.error.details (oneOf 3)` | object | Да | required: ["retry_after"]; Дополнительные поля запрещены | | | `$.error.details (oneOf 3).retry_after` | integer | Да | minimum: 0 | | | `$.error.request_id` | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. | #### default (403) ```json { "error": { "code": "forbidden", "message": "Source IP address is not allowed.", "details": [], "request_id": "11111111-1111-4111-8111-111111111111" } } ``` #### supportTest (403) ```json { "error": { "code": "forbidden", "message": "Support is available only to live credentials.", "details": [], "request_id": "11111111-1111-4111-8111-111111111111" } } ``` ### HTTP 404 Ресурс недоступен в контексте или весь reseller API отключён. Не отличайте чужое от отсутствующего. **Заголовок `X-Request-ID`**: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута. | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | string | Да | format: "uuid" | | **Content-Type:** `application/json` | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope | | `$.error` | object | Да | required: ["code","message","details","request_id"] | | | `$.error.code` | string | Да | | Машинный код; не извлекайте причину из message. | | `$.error.message` | string | Да | | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. | | `$.error.details` | oneOf | Да | | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. | | `$.error.details (oneOf 1)` | array | Да | maxItems: 0 | | | `$.error.details (oneOf 2)` | object | Да | | | | `$.error.details (oneOf 2).*` | array | Нет | | | | `$.error.details (oneOf 2).*[]` | string | Да | | | | `$.error.details (oneOf 3)` | object | Да | required: ["retry_after"]; Дополнительные поля запрещены | | | `$.error.details (oneOf 3).retry_after` | integer | Да | minimum: 0 | | | `$.error.request_id` | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. | #### default (404) ```json { "error": { "code": "resource_not_found", "message": "Not Found", "details": [], "request_id": "11111111-1111-4111-8111-111111111111" } } ``` ### HTTP 429 Квота API-ключа исчерпана. Ждите Retry-After. Собственный 429 не содержит X-RateLimit-Limit/Remaining/Reset. **Заголовок `X-Request-ID`**: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута. | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | string | Да | format: "uuid" | | **Заголовок `Retry-After`**: На 429 API: целые секунды до сброса окна, не дата/Unix timestamp. При 0 добавьте jitter. Proxy может вернуть HTTP-date. | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | string | Да | pattern: "^[0-9]+$" | | ```text Retry-After: 42 ``` **Content-Type:** `application/json` | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope | | `$.error` | object | Да | required: ["code","message","details","request_id"] | | | `$.error.code` | string | Да | | Машинный код; не извлекайте причину из message. | | `$.error.message` | string | Да | | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. | | `$.error.details` | oneOf | Да | | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. | | `$.error.details (oneOf 1)` | array | Да | maxItems: 0 | | | `$.error.details (oneOf 2)` | object | Да | | | | `$.error.details (oneOf 2).*` | array | Нет | | | | `$.error.details (oneOf 2).*[]` | string | Да | | | | `$.error.details (oneOf 3)` | object | Да | required: ["retry_after"]; Дополнительные поля запрещены | | | `$.error.details (oneOf 3).retry_after` | integer | Да | minimum: 0 | | | `$.error.request_id` | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. | #### default (429) ```json { "error": { "code": "rate_limit_exceeded", "message": "API rate limit exceeded.", "details": { "retry_after": 42 }, "request_id": "11111111-1111-4111-8111-111111111111" } } ``` ### HTTP 500 Этот HTTP-ответ не определяет результат записи. Сначала сверка; повтор только с прежним ключом и точным телом. **Заголовок `X-Request-ID`**: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута. | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | string | Да | format: "uuid" | | **Content-Type:** `application/json` | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope | | `$.error` | object | Да | required: ["code","message","details","request_id"] | | | `$.error.code` | string | Да | | Машинный код; не извлекайте причину из message. | | `$.error.message` | string | Да | | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. | | `$.error.details` | oneOf | Да | | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. | | `$.error.details (oneOf 1)` | array | Да | maxItems: 0 | | | `$.error.details (oneOf 2)` | object | Да | | | | `$.error.details (oneOf 2).*` | array | Нет | | | | `$.error.details (oneOf 2).*[]` | string | Да | | | | `$.error.details (oneOf 3)` | object | Да | required: ["retry_after"]; Дополнительные поля запрещены | | | `$.error.details (oneOf 3).retry_after` | integer | Да | minimum: 0 | | | `$.error.request_id` | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. | #### default (500) ```json { "error": { "code": "internal_error", "message": "The request could not be completed.", "details": [], "request_id": "11111111-1111-4111-8111-111111111111" } } ``` ## Дополнительные примеры из контракта ### cURL ```bash BASE_URL='https://api.b.websoft.kz/api/reseller/v1' # BASE_URL включает /api/reseller/v1. Подставьте реальные UUID своего окружения. # Для нового намеренного действия задайте новый IDEMPOTENCY_KEY; для повтора сохраните прежний. curl --request GET "$BASE_URL/domains" \ --header "Authorization: Bearer $RESELLER_API_TOKEN" \ --header "Accept: application/json" ``` ## Машиночитаемый контракт [OpenAPI JSON](/openapi.json) · [OpenAPI YAML](/reseller-api-openapi.yaml) · Markdown этой операции ::: details Источники проверки контракта - `routes/api/reseller/v1.php` - `app/Application/ResellerApi/V1/Controller/DomainController.php` :::