Получить покупателя

GET /customers/{customerUuid}

operationId: getCustomer

UUID чужого реселлера/среды недоступен. Не трактуйте отсутствие в test как отсутствие в live. Системные покупатели исключены.

Scopes: customers.read

Параметры

customerUuid

Расположение: path. Обязательный. UUID ресурса текущего реселлера.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	string	Да	format: "uuid"

Тело запроса

Тело запроса отсутствует.

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

bash

API_BASE_URL='https://api.b.websoft.kz/api/reseller/v1'
: "${RESELLER_API_TOKEN:?Set RESELLER_API_TOKEN in your environment}"
: "${CUSTOMER_UUID:?Set CUSTOMER_UUID}"

curl --request GET "$API_BASE_URL/customers/${CUSTOMER_UUID}" \
  --connect-timeout 5 --max-time 20 --fail-with-body \
  --header "Authorization: Bearer $RESELLER_API_TOKEN" \
  --header 'Accept: application/json'

php

<?php
declare(strict_types=1);

// PHP 8.0+; extensions: curl, json. Persist the key/body before any write.
function requiredEnv(string $name): string
{
    $value = getenv($name);
    if ($value === false || $value === '' || str_contains($value, "\r") || str_contains($value, "\n")) {
        throw new RuntimeException('Set a valid environment variable: ' . $name);
    }
    return $value;
}

$baseUrl = rtrim(getenv('API_BASE_URL') ?: 'https://api.b.websoft.kz/api/reseller/v1', '/');
$path = '/customers/{customerUuid}';
$path = str_replace('{customerUuid}', rawurlencode(requiredEnv('CUSTOMER_UUID')), $path);
$url = $baseUrl . $path;
$headers = [
    'Authorization: Bearer ' . requiredEnv('RESELLER_API_TOKEN'),
    'Accept: application/json',

];

$responseHeaders = [];
$handle = curl_init($url);
if ($handle === false) {
    throw new RuntimeException('Cannot initialize cURL.');
}
try {
    if (!curl_setopt_array($handle, [
        CURLOPT_CUSTOMREQUEST => '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;

// 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 = "/customers/{customerUuid}";
path = path.replaceAll("{customerUuid}", encodeURIComponent(requiredEnv("CUSTOMER_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 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 = "/customers/{customerUuid}"
path = path.replace("{customerUuid}", quote(required_env("CUSTOMER_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 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 := "/customers/{customerUuid}"
    value0 := requiredEnv("CUSTOMER_UUID")
    path = strings.ReplaceAll(path, "{customerUuid}", 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 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 = "/customers/{customerUuid}";
        path = path.replace("{customerUuid}", URLEncoder.encode(requiredEnv("CUSTOMER_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<String> 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 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 = "/customers/{customerUuid}";
path = path.Replace("{customerUuid}", Uri.EscapeDataString(RequiredEnv("CUSTOMER_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-ключ отсутствует, недействителен, отозван или истёк.	Проверьте ключ и его срок, не повторяйте с теми же неверными credentials.
403	`forbidden`	Scope, IP allowlist, режим или состояние реселлера не разрешает запрос.	Проверьте scopes, среду, allowlist и настройки реселлера через администратора.
404	`resource_not_found`	Маршрут отключён конфигурацией либо объект недоступен в текущем контексте.	Проверьте UUID, среду и принадлежность; при отключённой функции обратитесь к оператору.
422	`validation_failed`	Параметры не прошли валидацию или не выполнены бизнес-условия.	Исправьте поля из error.details/условия. Не повторяйте неизменённый невалидный запрос.
429	`rate_limit_exceeded`	Лимит текущего API-ключа исчерпан.	Учитывайте Retry-After при наличии, используйте backoff с jitter. Запись повторяйте с прежним Idempotency-Key и неизменённым телом.
500	`internal_error`	Необработанная ошибка выполнения; это не подтверждение отсутствия побочного эффекта.	Сохраните request_id; сначала проверьте состояние объекта, затем повторяйте запись с тем же ключом. Для неоднозначного результата обращайтесь в поддержку.

HTTP 200

Успешный ответ.

Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	string	Да	format: "uuid"

Заголовок X-RateLimit-Limit: Лимит API-ключа на 60 секунд. После прохождения ограничителя, включая replay. Отсутствует в собственной ветке 429 и при раннем отказе.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	integer	Да	minimum: 1

text

X-RateLimit-Limit: 120

Заголовок X-RateLimit-Remaining: Остаток после запроса. Снимок, не гарантия при конкуренции. Отсутствует в собственной ветке 429 и при раннем отказе.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	integer	Да	minimum: 0

text

X-RateLimit-Remaining: 119

Content-Type: application/json

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	object	Да	required: ["data"]	Успешный ответ. Схема: CoreCustomerEnvelope
`$.data`	object	Да	required: ["uuid","external_id","type","status","display_name","email","phone","preferred_currency","locale","timezone","profile","created_at","updated_at"]	Покупатель биллинга, не контакт реестра и не bearer-ключ. Схема: CoreCustomer
`$.data.uuid`	string	Да	format: "uuid"	UUID объекта.
`$.data.external_id`	string / null	Да		Идентификатор клиента во внешнем биллинге.
`$.data.type`	string	Да	enum: "individual", "legal"	Тип.
`$.data.status`	string	Да		Состояние клиента.
`$.data.display_name`	string	Да		Отображаемое имя.
`$.data.email`	string / null	Да	format: "email"	Email клиента.
`$.data.phone`	string / null	Да		Телефон.
`$.data.preferred_currency`	string	Да		Предпочитаемая валюта.
`$.data.locale`	string	Да		Язык.
`$.data.timezone`	string	Да		Часовой пояс.
`$.data.profile`	oneOf	Да		Для legal возвращается юридический профиль, для individual физический.
`$.data.profile (oneOf 1)`	object	Да	required: ["first_name","last_name","middle_name","birth_date","country_code","city","address_line","postal_code"]	Профиль физического лица. Схема: CoreIndividualProfile
`$.data.profile (oneOf 1).first_name`	string / null	Да		Имя.
`$.data.profile (oneOf 1).last_name`	string / null	Да		Фамилия.
`$.data.profile (oneOf 1).middle_name`	string / null	Да		Отчество.
`$.data.profile (oneOf 1).birth_date`	string / null	Да	format: "date"	Дата рождения.
`$.data.profile (oneOf 1).country_code`	string / null	Да		Страна, код из двух символов.
`$.data.profile (oneOf 1).city`	string / null	Да		Город.
`$.data.profile (oneOf 1).address_line`	string / null	Да		Адрес.
`$.data.profile (oneOf 1).postal_code`	string / null	Да		Почтовый индекс.
`$.data.profile (oneOf 2)`	object	Да	required: ["company_name","registration_number","tax_number","legal_address","actual_address","director_full_name"]	Профиль юридического лица. Схема: CoreLegalProfile
`$.data.profile (oneOf 2).company_name`	string / null	Да		Название организации.
`$.data.profile (oneOf 2).registration_number`	string / null	Да		Регистрационный номер.
`$.data.profile (oneOf 2).tax_number`	string / null	Да		Налоговый номер.
`$.data.profile (oneOf 2).legal_address`	string / null	Да		Юридический адрес.
`$.data.profile (oneOf 2).actual_address`	string / null	Да		Фактический адрес.
`$.data.profile (oneOf 2).director_full_name`	string / null	Да		ФИО руководителя.
`$.data.created_at`	string / null	Да	format: "date-time"	Создан.
`$.data.updated_at`	string / null	Да	format: "date-time"	Изменён.

Физическое лицо (200)

json

{
  "data": {
    "uuid": "019a0000-0000-7000-8000-000000000010",
    "external_id": "customer-1042",
    "type": "individual",
    "status": "active",
    "display_name": "Иван Петров",
    "email": "ivan@example.com",
    "phone": "+77010000000",
    "preferred_currency": "KZT",
    "locale": "ru",
    "timezone": "Asia/Almaty",
    "profile": {
      "first_name": "Иван",
      "last_name": "Петров",
      "middle_name": "Иванович",
      "birth_date": "1990-01-01",
      "country_code": "KZ",
      "city": "Алматы",
      "address_line": "ул. Примерная, 10",
      "postal_code": "050000"
    },
    "created_at": "2026-10-05T09:00:00+00:00",
    "updated_at": "2026-10-05T09:00:00+00:00"
  }
}

Организация (200)

json

{
  "data": {
    "uuid": "019a0000-0000-7000-8000-000000000011",
    "external_id": "company-1043",
    "type": "legal",
    "status": "active",
    "display_name": "ТОО \"Example\"",
    "email": "admin@example.com",
    "phone": "+77010000000",
    "preferred_currency": "KZT",
    "locale": "ru",
    "timezone": "Asia/Almaty",
    "profile": {
      "company_name": "ТОО \"Example\"",
      "registration_number": "EXAMPLE-2026",
      "tax_number": null,
      "legal_address": "Алматы, ул. Примерная, 10",
      "actual_address": "Алматы, ул. Примерная, 10",
      "director_full_name": "Иван Петров"
    },
    "created_at": "2026-10-05T09:00:00+00:00",
    "updated_at": "2026-10-05T09:00:00+00:00"
  }
}

HTTP 401

Bearer-ключ отсутствует, недействителен, отозван или истёк.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	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 allowlist, режим или состояние реселлера не разрешает запрос.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	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

Маршрут отключён конфигурацией либо объект недоступен в текущем контексте.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	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 422

Параметры не прошли валидацию или не выполнены бизнес-условия.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	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 (422)

json

{
  "error": {
    "code": "validation_failed",
    "message": "A valid Idempotency-Key header is required.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

fields (422)

json

{
  "error": {
    "code": "validation_failed",
    "message": "The name field is required.",
    "details": {
      "name": [
        "The name field is required."
      ]
    },
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

HTTP 429

Превышен общий лимит текущего API-ключа по всем методам (в том числе replay). Квота отдельных EPP-команд и фоновых задач не равна этому HTTP-лимиту.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	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

Необработанная ошибка выполнения; это не подтверждение отсутствия побочного эффекта.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	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"
  }
}

Машиночитаемый контракт

OpenAPI JSON · OpenAPI YAML · Markdown этой операции

Получить покупателя ​

Параметры ​

customerUuid ​

Тело запроса ​

Пример запроса ​

Ответы ​

Условия ошибок и восстановление ​

HTTP 200 ​

Физическое лицо (200) ​

Организация (200) ​

HTTP 401 ​

default (401) ​

HTTP 403 ​

default (403) ​

supportTest (403) ​

HTTP 404 ​

default (404) ​

HTTP 422 ​

default (422) ​

fields (422) ​

HTTP 429 ​

default (429) ​

HTTP 500 ​

default (500) ​

Машиночитаемый контракт ​

Получить покупателя

Параметры

customerUuid

Тело запроса

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

Ответы

Условия ошибок и восстановление

HTTP 200

Физическое лицо (200)

Организация (200)

HTTP 401

default (401)

HTTP 403

default (403)

supportTest (403)

HTTP 404

default (404)

HTTP 422

default (422)

fields (422)

HTTP 429

default (429)

HTTP 500

default (500)

Машиночитаемый контракт