Работа с публичным API для доменов

Публичный GraphQL API PS Cloud Services позволяет автоматизировать регистрацию, продление и проверку доменных имен.
API доступен по адресу: https://console.ps.kz/domains/graphql.

Возможности APIВозможности API

• регистрация доменов;
• продление доменов на нужный срок;
• проверка доступности доменных имен в реальном времени;
• интеграция с внутренними системами.

Регистрация домена через APIРегистрация домена через API

Пример запроса содержится в файле:
domain-registration.txt

Входные поля

• domainName — имя домена, обязательно.
• years — срок регистрации (1–10 лет), обязательно.
• nameservers — список неймсерверов; минимум 2.
• privacyProtection — скрытие данных владельца (по умолчанию: true).
• registrant — объект владельца домена.
• registrantTemplateHandle — ID шаблона контакта.
• admin, adminTemplateHandle — данные администратора.
• extensions — для зоны .kz обязательны месторасположение сервера и цель.

Поля ответа

• domainName
• years, creationDate, expirationDate, price
• registrantTemplateHandle, adminTemplateHandle
• errors (code, description, data)

Возможные ошибки при регистрации

• DOMAIN_ALREADY_EXISTS
• WRONG_DOMAIN_NAME
• YEARS_LIMIT_VIOLATED
• MIN_NAMESERVERS, MAX_NAMESERVERS, NAMESERVER_NOT_EXIST
• REGISTRANT_IS_REQUIRED
• REQUIRED_EXTENSION_IS_MISSING
• TLD_NOT_AVAILABLE
• REGISTRANT_FIELDS_ARE_MISSING
• ADMIN_FIELDS_ARE_MISSING
• TEMPLATE_NOT_FOUND
• WRONG_PARAMETERS
• INSUFFICIENT_ACCOUNT_BALANCE
• UNEXPECTED_ERROR

Примеры ошибок

• Не указано месторасположение сервера для .kz:

server-location-missing.txt

• Не указана цель для .kz:

purpose-missing.txt

• Домен уже зарегистрирован:

domain-already-exists.txt

• Премиальный домен:

domain-premium.txt

• Некорректные поля в шаблоне:

invalid-template-fields.txt

• Неймсерверы не существуют:

nameserver-not-exist.txt

Поля для создания контактаПоля для создания контакта

Тип контакта

• type, residence

Физическое лицо

• person_firstName, person_lastName, person_patronymic
• person_firstNameLatin, person_lastNameLatin
• person_birthDate (ru)
• taxId (uz)

Паспортные данные

• passport_code, passport_number
• passport_who, passport_whoLatin
• passport_issueDate, passport_expirationDate

Юридическое лицо

• legalEntity_name, legalEntity_role
• legalEntity_nameLatin

Банковские реквизиты (uz)

• uz_bankName, uz_bankNameLatin
• uz_bankAccount, uz_regionCode

Контактные данные

• contact_email, contact_phone, contact_fax (опц.)

Адрес

• address_street, address_city, address_state
• address_streetLatin, address_cityLatin, address_stateLatin
• address_postalCode, address_countryCode

Автоматическое продление доменаАвтоматическое продление домена

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

domain-auto-renewal.txt

Входные поля

• domainName
• years
• currentExpirationDate

Ответ

• domainName
• invoiceNum
• price
• expirationDate
• errors

Ошибки

• DOMAIN_NOT_FOUND
• WRONG_EXPIRATION_DATE
• INSUFFICIENT_ACCOUNT_BALANCE
• UNEXPECTED_ERROR

Проверка доступности доменовПроверка доступности доменов

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

domain-availability-check.txt

Поля запроса

• domains — список доменов

Поля ответа

• domain — доменное имя
• tld — доменная зона
• available — доступность
• reason — причина недоступности

Возможные причины недоступности

• WRONG_DOMAIN_NAME
• TLD_NOT_AVAILABLE
• DOMAIN_EXISTS
• DOMAIN_IS_PREMIUM
• REGISTRY_CHECK_ERROR

Пример ответа

domain-availability-response-example.txt

ИтогИтог

API доменов PS Cloud Services позволяет автоматизировать:

• регистрацию доменов,
• продление доменных имен,
• проверку их доступности.

Для корректной работы необходимо учитывать требования к полям и возможные ошибки в ответах API.