# Проверить поддерживаемые операции `GET /domains/{domainUuid}/capabilities` **operationId:** `getDomainCapabilities` Требуемые scopes: domains.read. Ответ зависит от интерфейсов драйвера, active integration credential и migration hold, но НЕ учитывает scopes ключа, баланс и все EPP-ограничения. true не обещает успешное действие. DNSSEC всегда false; методов управления DNSSEC или A/MX/TXT здесь нет. renewal_available_at отражает только первые 24 часа, maximum_term_years ограничивает оставшийся срок; дополнительные запреты смотрите в описании renew. Лимит общий для всех запросов одного API-ключа (rate_limit_per_minute, значение по умолчанию при выдаче ключа 120, индивидуальное значение может отличаться). Окно счётчика 60 секунд. Учитывайте X-RateLimit-Limit и X-RateLimit-Remaining; при 429 дождитесь Retry-After секунд и добавьте jitter. Polling и повторы также расходуют лимит; лимиты реестра независимы. **Scopes:** `domains.read` **x-input-caveats:** ```json [ "Передавайте синтаксически корректный UUID. Не все методы выполняют явную UUID-валидацию до SQL; поведение malformed UUID не унифицировано и в PostgreSQL может дать 500 вместо 404/422. Это ограничение реализации, не рекомендуемый сценарий клиента." ] ``` ## Параметры ### domainUuid Расположение: `path`. Обязательный. UUID из ответа API. Передавайте корректную строку UUID. Ресурс другого реселлера или среды не раскрывается. | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | string | Да | format: "uuid" | | ## Тело запроса Тело запроса отсутствует. ## Пример запроса ::: 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}" : "${DOMAIN_UUID:?Set DOMAIN_UUID}" curl --request GET "$API_BASE_URL/domains/${DOMAIN_UUID}/capabilities" \ --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/{domainUuid}/capabilities"; path = path.replaceAll("{domainUuid}", encodeURIComponent(requiredEnv("DOMAIN_UUID"))); const url = baseUrl + path; 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/{domainUuid}/capabilities" path = path.replace("{domainUuid}", quote(required_env("DOMAIN_UUID"), safe="")) url = base_url + path 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" "net/url" "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/{domainUuid}/capabilities" value0 := requiredEnv("DOMAIN_UUID") path = strings.ReplaceAll(path, "{domainUuid}", url.PathEscape(value0)) endpoint := strings.TrimRight(baseURL, "/") + path 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/{domainUuid}/capabilities"; path = path.replace("{domainUuid}", URLEncoder.encode(requiredEnv("DOMAIN_UUID"), StandardCharsets.UTF_8).replace("+", "%20")); URI uri = URI.create(baseUrl + path); 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/{domainUuid}/capabilities"; path = path.Replace("{domainUuid}", Uri.EscapeDataString(RequiredEnv("DOMAIN_UUID"))); 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); 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` | UUID не найден у этого провайдера/окружения, либо запись удалена/скрыта migration hold. | Проверьте UUID, test/live и принадлежность. Не пытайтесь получить ресурс чужого провайдера. | | 404 | `resource_not_found` | Reseller API глобально выключен конфигурацией. | Уточните base URL и включение API у оператора. | ### HTTP 200 Успешное чтение или сохранение настройки. **Content-Type:** `application/json` | Поле | Тип | Обязательно в родителе | Ограничения | Описание | | --- | --- | --- | --- | --- | | `$` | object | Да | required: ["data"] | Схема: DomainCapabilitiesEnvelope | | `$.data` | object | Да | required: ["operations","renewal_available_at","maximum_term_years","auto_renew","whois_privacy"] | | | `$.data.operations` | object | Да | required: ["renew","transfer","transfer_query","transfer_approve","transfer_reject","transfer_cancel","restore","nameservers","contacts","statuses","delete","auth_code","privacy","sync","host_create","host_update","host_delete","host_info","dnssec"] | | | `$.data.operations.renew` | boolean | Да | | Поддержка renew драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.transfer` | boolean | Да | | Поддержка transfer драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.transfer_query` | boolean | Да | | Поддержка transfer_query драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.transfer_approve` | boolean | Да | | Поддержка transfer_approve драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.transfer_reject` | boolean | Да | | Поддержка transfer_reject драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.transfer_cancel` | boolean | Да | | Поддержка transfer_cancel драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.restore` | boolean | Да | | Поддержка restore драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.nameservers` | boolean | Да | | Поддержка nameservers драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.contacts` | boolean | Да | | Поддержка contacts драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.statuses` | boolean | Да | | Поддержка statuses драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.delete` | boolean | Да | | Поддержка delete драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.auth_code` | boolean | Да | | Поддержка auth_code драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.privacy` | boolean | Да | | Поддержка privacy драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.sync` | boolean | Да | | Поддержка sync драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.host_create` | boolean | Да | | Поддержка host_create драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.host_update` | boolean | Да | | Поддержка host_update драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.host_delete` | boolean | Да | | Поддержка host_delete драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.host_info` | boolean | Да | | Поддержка host_info драйвером при активной интеграции и отсутствии migration hold. Не гарантирует достаточный scope/баланс/допустимость текущего состояния. | | `$.data.operations.dnssec` | boolean | Да | | Всегда false: DNSSEC не реализован в текущем контракте. | | `$.data.renewal_available_at` | string / null | Да | format: "date-time" | registered_at + 24 часа; null, если дата регистрации неизвестна. Дополнительные ограничения продления сохраняются. | | `$.data.maximum_term_years` | integer | Да | const: 10 | Предельный суммарный оставшийся срок: новая expires_at не позднее текущего времени + 10 календарных лет. | | `$.data.auto_renew` | boolean | Да | | Согласие на автопродление. | | `$.data.whois_privacy` | object | Да | required: ["enabled","status","hidden_fields","available_fields","last_applied_at"] | | | `$.data.whois_privacy.enabled` | boolean | Да | | Локальное включение WHOIS privacy. | | `$.data.whois_privacy.status` | string | Да | | Состояние применения; строка без закрытого enum. | | `$.data.whois_privacy.hidden_fields` | array | Да | | Скрываемые поля. | | `$.data.whois_privacy.hidden_fields[]` | string | Да | enum: "name", "organization", "address", "phone", "fax", "email" | Поле раскрытия WHOIS. Схема: DomainPrivacyField | | `$.data.whois_privacy.available_fields` | array | Да | | Поддерживаемые поля политики раскрытия. | | `$.data.whois_privacy.available_fields[]` | object | Да | required: ["code","label","registrar_field","description"] | | | `$.data.whois_privacy.available_fields[].code` | string | Да | enum: "name", "organization", "address", "phone", "fax", "email" | Поле раскрытия WHOIS. Схема: DomainPrivacyField | | `$.data.whois_privacy.available_fields[].label` | string | Да | | Локализованное название. | | `$.data.whois_privacy.available_fields[].registrar_field` | string | Да | | XML-поле регистратора. | | `$.data.whois_privacy.available_fields[].description` | string | Да | | Локализованное пояснение. | | `$.data.whois_privacy.last_applied_at` | string / null | Да | format: "date-time" | Последнее применение либо null. | #### Пример возможностей настроенного драйвера; проверяйте ответ конкретного домена (200) ```json { "data": { "operations": { "renew": true, "transfer": true, "transfer_query": true, "transfer_approve": true, "transfer_reject": true, "transfer_cancel": true, "restore": true, "nameservers": true, "contacts": true, "statuses": true, "delete": true, "auth_code": true, "privacy": true, "sync": true, "host_create": true, "host_update": true, "host_delete": true, "host_info": true, "dnssec": false }, "renewal_available_at": "2026-10-02T08:00:00+00:00", "maximum_term_years": 10, "auto_renew": false, "whois_privacy": { "enabled": false, "status": "disabled", "hidden_fields": [], "available_fields": [ { "code": "name", "label": "Имя", "registrar_field": "contact:name", "description": "Настройка раскрытия поля Имя" }, { "code": "organization", "label": "Организация", "registrar_field": "contact:org", "description": "Настройка раскрытия поля Организация" }, { "code": "address", "label": "Адрес", "registrar_field": "contact:addr", "description": "Настройка раскрытия поля Адрес" }, { "code": "phone", "label": "Телефон", "registrar_field": "contact:voice", "description": "Настройка раскрытия поля Телефон" }, { "code": "fax", "label": "Факс", "registrar_field": "contact:fax", "description": "Настройка раскрытия поля Факс" }, { "code": "email", "label": "Email", "registrar_field": "contact:email", "description": "Настройка раскрытия поля Email" } ], "last_applied_at": 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/019a1234-1000-7000-8000-000000000001/capabilities" \ --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/DomainOperationController.php` :::