Реселлерский API

Мы предоставляем полноценный HTTP API для всех наших реселлеров

Общие положения

Внимание!

API не предназначен для перехвата удаляющихся доменов, введены ограничения на количество запросов, за нарушения будем банить.
Для автоматизированного перехвата доступен специальный интерфейс.

По независящим от нас обстоятельствам иногда выполнение операции может занимать до 10 минут. Поэтому ставьте таймаут ожидания ответа от АПИ - 10 минут.

  • API доступен по HTTPS;
  • доступны тестовая и рабочая версии API по адресам https://demo-api.domaincontext.com и https://api.domaincontext.com соответственно;
  • запросы шлются по адресу https://api.domaincontext.com/apiCommand. Данные запроса передаются с помощью GET или POST переменных;
  • для авторизация используются перменные auth_login и auth_password;
  • результаты запроса возвращаются закодированными в JSON;
  • в случае ошибки в возвращенном массиве будет элемент с ключом "_error" содержащий описание ошибки;
  • допустимыми результатами запроса могут быть:
    • скаляр "true"
    • массив не содержащий элемент с ключом "_error" (в нём передаётся описание ошибки)
    • любой другой результат, в том числе пустой - это ошибка
Пример:
https://demo-api.domaincontext.com/domainsCheck?auth_login=demo&auth_password=demo&domains=test.com,adfwer234asdf.net

Пример полностью рабочий, можно скопировать URL в браузер и поиграться, посмотреть вывод ошибок.

Подробные примеры

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

Команда Описание Аргументы
domainsCheck Проверка доступности доменов
  • domains — domains, *
domainRegister Регистрация доменов
  • domain — domain, *
  • period — period, по умолчанию: 1 год
  • по независящим от нас обстоятельствам иногда выполнение операции может занимать до 10 минут. поэтому ставьте таймаут ожидания ответа от апи - 10 минут.
domainsRegister Domains registration
  • массив — domainRegister
  • по независящим от нас обстоятельствам иногда выполнение операции может занимать до 10 минут. поэтому ставьте таймаут ожидания ответа от апи - 10 минут.
domainGetInfo Get information of the domain
  • domain — domain
  • id — id
domainsGetInfo Get information of given domains
  • массив — domainGetInfo
domainSetNote Установка клиентского примечания для домена
  • domain — domain
  • note — label
  • id — id
domainsSetNote Set client note for given domains
  • массив — domainSetNote
domainsSetDNS Set DNS settings for given domain
  • массив — domainSetDNS
serverBuy Buy server
  • tariff - label,*
  • cluster_id - id,* (один из: 1 - Нидерланды, Амстердам, 2 - США, Эшбурн)
  • osimage - eid,* (доступные значения могут быть получены с помощью комманды osimagesSearch)
  • panel - ref
  • social - label
  • purpose - label
  • callback_url - url

2.1. domainsCheck

Единственный аргумент этой команды - "domains" - список доменнов через запятую для проверки их доступности для регистрации.
* - "звёздочка", значит что аргумент обязательный, если он не передан будет ошибка.

https://demo-api.domaincontext.com/domainsCheck?auth_login=demo&auth_password=demo&domains=test.com,adfwer234asdf.net

2.2. domainRegister

Обязательно указывать только имя домена, для остальных параметров предусмотрены дефолты.

https://demo-api.domaincontext.com/domainRegister?auth_login=demo&auth_password=demo&domain=test42345.com

2.3. domainsRegister

Пример bulk-операции - одновременно над несколькими объектами. В описании аргументов используется слово "массив" - обозначающее что должен передаваться массив каждый элемент которого подходит в качестве аргумента для указанной операции, в данном случае domainRegister.

по независящим от нас обстоятельствам иногда выполнение операции может занимать до 10 минут. поэтому ставьте таймаут ожидания ответа от апи - 10 минут.

https://demo-api.domaincontext.com/domainsRegister?auth_login=demo&auth_password=demo&0[domain]=test42345.com&1[domain]=test123123.net

2.4. domainGetInfo

Всё просто - надо передать имя или ID домена. Возвращает массив данных о домене.

https://demo-api.domaincontext.com/domainGetInfo?auth_login=demo&auth_password=demo&domain=test42345.com

2.5. domainsGetInfo

Bulk-операция - одновременно над несколькими объектами.

https://demo-api.domaincontext.com/domainsGetInfo?auth_login=demo&auth_password=demo&0[domain]=test42345.com&1[domain]=test.com

2.6. domainSetNote

Пустой или не преданный "note" - удаляет примечание.

https://demo-api.domaincontext.com/domainSetNote?auth_login=demo&auth_password=demo&domain=test.com&note=abc

2.7. domainsSetNote

https://demo-api.domaincontext.com/domainsSetNote?auth_login=demo&auth_password=demo&0[domain]=test.com&0[note]=abc&1[domain]=test3.com&1[note]=def

2.8. domainsSetDNS

https://demo-api.domaincontext.com/domainsSetDNS?auth_login=demo&auth_password=demo&5504202[1][type]=a&5504202[1][value]=123.123.123.123&5504202[1][no]=1&5504202[1][ttl]=7200&5504202[1][status]=new

2.9. serverBuy

https://demo-api.domaincontext.com/serverBuy?auth_login=demo&auth_password=demo&tariff=XENSSD%20VDS%204%20100+&os=centos&panel=isp&cluster_id=1&social=test&purpose=test&callback_url=http:\/\/my.domain.com\/page\/for\/callback

Справочник типов

Тип Описание
* Обязательное поле, значение должно быть непустое, не ноль, не пустая строка и не пустой список.
Поля без звёздочки - необязательны для заполнения, могут не передаваться при вызове команды.
id Айдишник. Целое число больше нуля.
Например: 314123
ids Список айдишников, через запятую, пробельные символы допускаются.
Например: 1234, 324534, 223423
domain Доменное имя
Например: domain.com
domains Список доменов, через запятую, пробельные символы допускаются.
Например: domain.com, asdf.net
ns Имя NS'а (name server'а).
Например: ns1.domain.com
nss Список NS'ов, через запятую, пробельные символы допускаются.
Например: ns1.domain.com, ns2.domain.com
eid Extended ID - расширенный айдишник. Допускаются цифры, латинские буквы и символы: '_.:-' (подчерк, точка, двоеточие, минус).
Например: EID_234234:234—1
password Максимальная длина 64 символа. Не должен содержать символов переноса строки: \n, \r.
Например: We\p!Jie6w
period Целое число от 1 до 10. Используется для указания количества лет при регистрации и продлении.
Например: 1
date
expires		 Дата в ISO формате.
Например: 2012—09—25
ref Идентификатор. Состоит только из цифр, латинских букв и подчерка. Ограничений на первый символ нет.
Например: ok
Например: 7days
Например: 0001
refs Список идентификаторов, через запятую, пробельные символы допускаются.
Например: ok, nok, 123
label Строка почти без ограничений. Не допускаются символы переноса строки.
Например: Это имя клиента - Ivan Drago
labels Список строк, через запятую, пробельные символы допускаются. Допускается передача массивом.
Например: Ваня, Петя, Федя, John
dnsName Пустая строка, "*", "@" либо строка не длиннее 100 символов, состоящая из не более чем 4 частей, разделенных ".", каждая из которых состоит из 1-61 символов следующих типов: латинские символы, цифры и знаки "-" и "_" (при этом "-" не может быть первым или последним символом).
Например: *, @, n1, a1.b2, a1.b2.c3, a1.b2.c3.d4

Справочник команд

Команда Описание Аргументы
domainsCheck Проверка доступности доменов
  • domains — domains, *
domainsSearch List/Search domains
  • ids — ids
  • domain — label
  • domains — labels
  • note — labels
  • state — ref
  • client — labels
  • seller — labels
  • orderby — ref
  • limit — id
  • total — id
  • page — id
  • count — bool
  • show_dns — bool
  • show_fw_park — bool
  • dns — ref
  • view — ref
domainRegister Регистрация доменов
  • domain — domain, *
  • period — period — по умолчанию: 1 год
  • registrant — eid
  • admin — eid
  • tech — eid
  • billing — eid
  • по независящим от нас обстоятельствам иногда выполнение операции может занимать до 10 минут. поэтому ставьте таймаут ожидания ответа от апи - 10 минут.
domainsRegister Register domains
  • массив — domainRegister
  • по независящим от нас обстоятельствам иногда выполнение операции может занимать до 10 минут. поэтому ставьте таймаут ожидания ответа от апи - 10 минут.
domainCheckTransfer Проверяет данные для трансфера домена
  • domain — domain, *
  • password — password, *
domainsCheckTransfer Проверяет данные для трансфера доменов
  • массив — domainCheckTransfer
domainTransfer Проверяет данные для трансфера доменов
  • domain — domain, *
  • password — password, *
domainsTransfer Start domains transfer
  • массив — domainTransfer
domainApprovePreincoming Approve domains transfer
  • domains — list of domains, comma separeted
  • confirm_data - array of data from message
domainsRejectPreincoming Cancel domains transfer
  • domains - list of domains, comma separeted
  • confirm_data - array of data from message
domainGetNSs Get name servers of the domain
  • domain — domain
  • id — id
domainsGetNSs Get name servers of domains
  • массив — domainGetNSs
domainSetNSs Установка NS'ов для домена
  • domain — domain
  • nss — nss
  • id — id
domainsSetNSs Set name servers for given domains
  • массив — domainSetNSs
domainGetNote Get domain note
  • domain — domain
  • id — id
domainsGetNote Get domains note
  • массив — domainGetNote
domainSetNote Установка клиентского примечания для домена
  • domain — domain
  • note — label
  • id — id
domainsSetNote Set client note for given domains
  • массив — domainSetNote
domainRenew Domain renew
  • domain — domain, *
  • period — period, *
  • expires — expires, * — current expiration date
domainGetPassword Get domain password
  • domain — domain
  • pincode — pincode
  • id — id
domainsGetPassword Get domains password
  • массив — domainGetPassword
domainRegenPassword Domain regen password
  • domain — domain
  • pincode — pincode
  • id — id
domainsRegenPassword Domains regen password
  • массив — domainRegenPassword
domainGetInfo Get information of the domain
  • domain — domain
  • id — id
domainsGetInfo Get information of given domains
  • массив — domainGetInfo
domainGetContacts Get contacts of the domain
  • domain — domain
  • id — id
domainGetWPContacts Get WHOIS protected contacts of the domain
  • domain — domain
  • id — id
domainGetContactsInfo Get contacts info of the domain
  • такие же как — domainGetContacts
domainGetWPContactsInfo Get WHOIS protected contacts info of the domain
  • такие же как — domainGetContactsInfo
domainsGetContacts Get contacts of given domains
  • массив — domainGetContacts
domainsGetWPContacts Get WHOIS protected contacts of given domains
  • массив — domainGetContacts
domainsGetContactsInfo Get contacts info of given domains
  • массив — domainGetContacts
domainsGetWPContactsInfo Get WHOIS protected contacts info of given domains
  • массив — domainGetContacts
domainSetContacts Set domain contacts
  • domain — domain
  • id — id
  • registrant — eid, *
  • admin — eid, *
  • tech — eid, *
  • billing — eid, *
domainsSetContacts Set contacts for given domains
  • массив — domainSetContacts
domainEnableAutorenewal Enable autorenewal for the domain
  • domain — domain
  • id — id
domainDisableAutorenewal Disable autorenewal for the domain
  • такие же как — domainEnableAutorenewal
domainsEnableAutorenewal Enable autorenewal for given domains
  • массив — domainEnableAutorenewal
domainsDisableAutorenewal Disable autorenewal for given domains
  • массив — domainEnableAutorenewal
domainEnableWhoisProtect Enable whois protect for the domain
  • domain — domain
  • id — id
domainDisableWhoisProtect Enable whois protect for the domain
  • такие же как — domainEnableWhoisProtect
domainsEnableWhoisProtect Enable whois protect for given domains
  • массив — domainEnableWhoisProtect
domainsDisableWhoisProtect Disable whois protect for given domains
  • массив — domainEnableWhoisProtect
domainEnableLock Enable lock for the domain
  • domain — domain
  • id — id
domainDisableLock Disable lock for the domain
  • такие же как — domainEnableLock
domainsEnableLock Enable lock for given domains
  • массив — domainEnableLock
domainsDisableLock Disable lock for given domains
  • массив — domainEnableLock
domainGetDNS Get DNS settings for given domain
  • id — id
  • domain — domain
domainsGetDNS Get DNS settings for given domains
  • массив — domainGetDNS
domainSetDNS Set DNS settings for given domain
  • массив {
    • name — dnsName
    • type — ref
    • value — label
    • no — id
    • ttl — id
    • status — ref (ok,new,deleted)
    }
domainsSetDNS Set DNS settings for given domains
  • массив — domainSetDNS
domainPush Push domain to given client
  • domain — domain
  • id — id
  • sender — client, *
  • receiver — client, *
  • pincode — pincode
domainsPush Push domains to given receivers
  • массив — domainPush
hdomainGetDNS Get DNS settings for given domain
  • id — id
hdomainsGetDNS Get DNS settings for given domains
  • массив — hdomainGetDNS
hdomainSetDNS Set DNS settings for given domain
  • массив {
    • name — dnsName
    • type — ref
    • value — label
    • no — id
    • ttl — id
    • status — ref (ok,new,deleted)
    }
hdomainsSetDNS Set DNS settings for given domains
  • массив — domainSetDNS
hostsSearch Hosts search
  • ids — ids
  • host — labels
  • domain — labels
  • domain_ids — ids
  • note — labels
  • client — labels
  • seller — labels
  • orderby — ref
  • limit — id
  • total — id
  • page — id
  • count — bool
hostGetInfo Host get info
  • id — id
  • host — ns
hostsGetInfo Hosts get info
  • массив — hostGetInfo
hostCreate Host create
  • host — ns, *
  • ips — ips
hostsCreate Hosts create
  • массив — hostCreate
hostUpdate Host update
  • id — id
  • host — ns
  • ips — ips
hostsUpdate Hosts update
  • массив — hostUpdate
hostDelete Host delete
  • id — id
  • host — ns
hostsDelete Hosts delete
  • массив — hostDelete
contactsSearch List/Search contacts
  • ids — ids
  • name — labels
  • email — labels
  • client — labels
  • seller — labels
  • select — ref
  • orderby — ref
  • limit — id
  • total — id
  • page — id
  • count — bool
contactGetInfo Get contact info
  • id — eid, *
contactsGetInfo Get contacts info
  • массив — contactGetInfo
contactCreate Создать контакт
  • email — email, *
  • first_name — label, *
  • last_name — label
  • birth_date — date
  • organization — label
  • street1 — label, *
  • street2 — label
  • street3 — label
  • city — label, *
  • province — label
  • postal_code — label, *
  • country — ref, *
  • voice_phone — phone, *
  • fax_phone — phone
  • emails — emails
  • type — ref — один из: person, organization
  • passport_no — label
  • passport_date — date
  • passport_by — label
  • organization_ru — label — for .ru zone only
  • inn — label — for .ru zone only
  • kpp — label — for .ru zone only
  • director_name — label — for .ru zone only
  • isresident — boolean — for .ru zone only
contactsCreate Create contacts
  • массив — contactCreate
contactUpdate Update contact
  • id — id,*
  • pincode — pincode
  • email — email, *
  • first_name — label, *
  • last_name — label
  • birth_date — date
  • organization — label
  • street1 — label, *
  • street2 — label
  • street3 — label
  • city — label, *
  • province — label
  • postal_code — label, *
  • country — ref, *
  • voice_phone — phone, *
  • fax_phone — phone
  • emails — emails
  • passport_no — label
  • passport_date — date
  • passport_by — label
  • organization_ru — label
  • inn — label
  • kpp — label
  • director_name — label
  • isresident — boolean
contactsUpdate Update contacts
  • массив — contactUpdate
contactDelete Contact delete
  • id — id,*
contactsDelete Contacts delete
  • массив — contactDelete
clientCheck Check client login/password
  • login — client
  • password — passwrod
clientCreate Create new client
  • login — client, *
  • password — password, *
  • seller — client, *
  • all the fields from contactCreate
clientGetBalance Получить баланс клиента
  • id — id
  • client — client
  • currency — ref
clientGetPrices Get client prices
  • client — client
  • id — id
  • seller — client
  • seller_id — id
clientsGetPrices Get clients prices
  • массив — clientGetPrices
tariffsGetAvailable Get list of available tariffs
  • seller - client
  • type - ref (один из: domain, ovds, svds)
tariffGetInfo Get tariff info
  • id - id
tariffsGetInfo Get tariffs info
  • массив - tariffGetInfo
serversSearch Search servers
  • ids - ids
  • servers - servers
  • note - labels
  • client - client
  • seller - client
  • states - refs
  • orderby - ref
  • limit - id
  • page - id
serversGetList Get servers list
  • ids - ids
  • server - server
  • client - client
serverGetList Get servers list
  • массив - serverGetList
serverGetInfo Get server info
  • id - id
  • server - server
serversGetInfo Get servers info
  • массив - serverGetInfo
serverBuy Buy server
  • tariff - label,*
  • cluster_id - id,* (один из: 1 - Нидерланды, Амстердам, 2 - США, Эшбурн)
  • osimage - eid,* (доступные значения могут быть получены с помощью комманды osimagesSearch)
  • panel - ref
  • social - label
  • purpose - label
  • callback_url - url
  • amount - id, период, по умолчанию 1
serversBuy Buy servers
  • массив - serverBuy
serverRenew Renew server
  • server - server name
  • id - id
  • amount - id, период, по умолчанию 1
serversRenew Renew servers
  • массив - serverRenew
serverRefuse Refuse from server
  • id - id
  • server - server
serverReboot Reboot server
  • id - id
  • server - server
serversReboot Reboot servers
  • массив - serverReboot
serverReset Reset server
  • id - id
  • server - server
serversReset Reset servers
  • массив - serverReset
serverShutdown Shutdown server
  • id - id
  • server - server
serversShutdown Shutdown servers
  • массив - serverShutdown
serverPowerOn Server power on
  • id - id
  • server - server
serversPowerOn Servers power on
  • массив - serverPowerOn
serverPowerOff Server power off
  • id - id
  • server - label
serversPowerOff Servers power off
  • массив - serverPowerOff
serverResetup Resetup server
  • id - id
  • server - server
  • osimage - eid,* (см. serverBuy)
  • panel - ref (см. serverBuy)
serversResetup Resetup servers
  • массив - serverResetup
serverEnableVNC Enable VNC for server
  • id - id
  • server - label
serversEnableVNC Enable VNC for servers
  • массив - serverEnableVNC
serverRegenRootPassword Regenerate root password for server
  • id - id
  • server - server
serversRegenRootPassword Regenerate root password for servers
  • массив - serverRegenRootPassword
serverBootLive Загрузить сервер с Live CD
  • id - id
  • server - server
  • osimage - eid (один из: freebsdx64.live, gentoox64.live)
serversBootLive Загрузить сервер с Live CD
  • массив - serverBootLive
osimagesSearch Get list of available OS images
  • type - ref (один из: svds - XEN, ovds - OpenVZ)
certificatesSearch Certificates search
  • id - id
  • remoteid - eid
  • parent_id - id
  • is_parent - boolean
  • type_id - id
  • product_id - id
  • state_id - id
  • object_id - id
  • client_id - id
  • seller_id - id
  • name - label
  • type - ref
  • type_label - label
  • state - ref
  • client - client
  • seller - client
  • amount - period
  • begins - date
  • expires - date
  • show_chain - boolean
  • show_new - boolean
certificateGetInfo Get certificate info from DB
  • id - id, *
certificatesGetInfo et certificates info from DB
  • массив certificateGetInfo
certificateGetData Get certificate data
  • id - id, *
certificatesGetData Get certificates data
  • массив certificatesGetData
certificatePurchase Purchase certificate
  • product - ref
  • product_id - id
  • amount - period
  • client - client
  • client_id - id
  • object_id - id
  • coupon - coupon
certificatesPurchase Purchase certificates
  • массив certificatePurchase
certificateIssue Issue certificate
  • id - id, *
  • admin_id - id, *
  • tech_id - id, *
  • org_id - id
  • dcv_method - ref, *
  • approver_email - email
  • approver_emails - emails
  • webserver_type - ref
  • dns_names - hdomains
  • csr - text, *
certificatesIssue Issue certificates
  • массив certificateIssue
certificateReissue Reissue certificate
  • такой же как certificateIssue
certificatesReissue Reissue certificates
  • массив certificateReissue
certificateCancel Cancel certificate
  • id - id, *
  • reason - label, *
certificatesCancel Cancel certificates
  • массив certificateCancel
certificateRenew SSL order renew
  • id - id, *
  • expires - date, *
certificatesRenew SSL orders renew
  • массив certificateRenew
certificateGenerateCSR Create CSR for certificate
  • csr_commonname - label, *
  • csr_organization - label, *
  • csr_department - label, *
  • csr_city - label, *
  • csr_state - label, *
  • csr_country - label, *
  • csr_email - email, *
  • copy_to_email - boolean
  • client - client
  • client_id - id
certificateGenerateCsr Create CSR for certificate
  • такой же как certificateGenerateCSR
certificateDecodeCSR Decode CSR
  • csr - text
  • brand - ref
  • wildcard - bool
certificateDecodeCsr Create CSR for certificate
  • такой же как certificateDecodeCSR
certificateGetWebserverTypes Get web server types
  • supplier - ref
certificateGetDomainEmails Get valid approver email addresses for specified domain
  • id - id
  • domain - domain
  • csr - text
certificateSendNotifications Send notification
  • id - id, *
certificatesSendNotifications Send notifications
  • массив certificateSendNotifications
certificateRevalidate Validate certificate
  • id - id, *
certificatesRevalidate Validate certificates
  • массив certificateRevalidate
certificateChangeValidation Change certificate validation
  • id - id, *
  • dcv_method - ref, * (доступные значения: dns, http, https, email)
  • approver_email - email
  • approver_emails - emails
certificateChangeValidation Change certificates validation
  • массив certificatesRevalidate

Оформление заказа и другие вопросы

Способы организации сотрудничества

Реселлерский сайт на базе DomainContext Inc.

Нашим партнерам мы предлагаем получить стандартный реселлерский сайт, на базе DomainContext Inc.
Он предоставляется совершенно бесплатно. Вам необходимо сообщить нам следующую информацию:

  • ваш логин в панели управления;
  • домен, на котором будет располагаться панель управления;
  • ssl сертификат и приватный ключ;
  • еmail, на который будут приходить все уведомления;
  • web адрес сервиса, который будет отображаться в whois зарегистрированного домена;
  • перечень платежных систем, которые будут доступны к оплате на вашем сайте (вы можете подключить WebMoney, PayPal, eCoin, ePayService/EPSBanking, Paxum, OkPay).
  • контактные данные, которые будут опубликованы на сайте (ICQ, Skype — по желанию);
  • языки, которые будут доступны по-умолчанию на сайте (русский/английский).

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

Что бы стать реселлером доменов Вам достаточно обратится по указанным контактам:

Mailsale@domaincontext.com
Важно!

Сохраните запрос на покупку SSL сертификата (CSR) и Приватный ключ (RSA).
После покупки SSL сертификата, Вам необходимо предоставить нам сам SSL сертификат и Приватный ключ (RSA).
Сгенерировать запрос на SSL вы можете на этой странице: ssl.com.ua/online-CSR-generator

© 2024 DomainContext Inc.. Все права защищены. Powered by HiPanel