Omnilance REST API

API documentation

hello
  • Клиенты

    Управление клиентами
    • Информация

      no implementation for this version
      Получение информации о клиенте
      Request:
      Resource:
      https://api.omnilance.com/{version}/customer/{customer_id}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      customer_id integer ID клиента
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Пример ответа
      "data": {
      "address": string, Адрес клиента
      "city": string, Город клиента
      "company": string, Компания
      "count_active_orders": integer, Активные заказы
      "country": string, Двухзначный код страны
      "id": integer, ID клиента
      "mail": string, E-mail клиента
      "name": string, Имя клиента
      "phone": string, Телефон клиента
      "region": string, Область клиента
      "zip": integer Почтовый индекс клиента
      },
      "status": boolean Request status
      }
      Codes:
      Code Message Description
      400 Invalid {{ param_name }} Неверно задан параметр
      403 Authorization failed Неверно указан токен
      403 Token not found В заголовках не передан токен
      404 ID not found Клиент не найден
      500 System Error
      Sample:
      Request:
      GET /v2.0/customer/42 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "data": { "address": "my_address", "city": "my_city", "company": "my_company", "count_active_orders": 42, "country": "my_country", "id": 42, "mail": "my_mail", "name": "my_name", "phone": "my_phone", "region": "my_region", "zip": 42 }, "status": true }
    • Редактирование

      no implementation for this version
      Редактирование клиента
      Request:
      Resource:
      https://api.omnilance.com/{version}/customer
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Body:
      Customer Изменение информации клиента
      Response:
      Body:
      { Ответ API
      "code": integer, Код ответа
      "status": boolean Статус ответа
      }
      Codes:
      Code Message Description
      400 Invalid {{ param_name }} Неверно задан параметр
      403 Authorization failed Неверно указан токен
      403 Token not found В заголовках не передан токен
      404 ID not found Клиент не найден
      500 System Error
      Sample:
      Request:
      PUT /v2.0/customer HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg== { "address": "Адрес клиента", "city": "Город клиента", "company": "Компания", "country": "UA", "fax": "380.631234567", "lang": "en", "mail": "customer@email.com", "name": "Имя клиента", "password": "1cdc@%)s$fd", "phone": "380.631234567", "post_adress": "Почтовый адресс клиента", "region": "Область клиента", "zip": 54000 }
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true }
    • Создание

      no implementation for this version
      Добавление нового клиента
      Request:
      Resource:
      https://api.omnilance.com/{version}/customer
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Body:
      Customer Данные нового клиента
      Response:
      Body:
      { Ответ API
      "code": integer, Код ответа
      "data": {
      "customer_id": integer ID созданного клиента
      },
      "status": boolean Статус ответа
      }
      Codes:
      Code Message Description
      400 Invalid {{ param_name }} Неверно задан параметр
      403 Authorization failed Неверно указан токен
      403 Mail already registered Клиент с таким email уже есть в системе
      403 Token not found В заголовках не передан токен
      500 System Error
      Sample:
      Request:
      POST /v2.0/customer HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg== { "address": "Адрес клиента", "city": "Город клиента", "company": "Компания", "country": "UA", "fax": "380.631234567", "lang": "en", "mail": "customer@email.com", "name": "Имя клиента", "password": "1cdc@%)s$fd", "phone": "380.631234567", "post_adress": "Почтовый адресс клиента", "region": "Область клиента", "zip": 54000 }
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "data": { "customer_id": 1 }, "status": true }
    • Удаление

      no implementation for this version
      Удаление клиента
      Request:
      Resource:
      https://api.omnilance.com/{version}/customer/{customer_id}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      customer_id integer ID клиента
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      {
      "code": integer,
      "msg": string,
      "status": boolean
      }
      Codes:
      Code Message Description
      403 Authorization failed Неверно указан токен
      403 Token not found В заголовках не передан токен
      403 You can not delete the contact has active orders Не возможно удаление клиента с активными заказами
      404 ID not found Клиент не найден
      500 System Error
      Sample:
      Request:
      DELETE /v2.0/customer/42 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 403, "msg": "You can not delete the customer has active orders", "status": true }
  • Контакты

    Управление контактами
    • Информация контакта

      no implementation for this version
      Получение информации о контакте
      Request:
      Resource:
      https://api.omnilance.com/{version}/contact/{contact_id}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      contact_id string Contact's ID
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Список параметров ответа
      "code": integer,
      "data": Contact,
      "status": boolean
      }
      Codes:
      Code Message Description
      403 Authorization failed Неверно указан токен
      403 Token not found В заголовках не передан токен
      404 ID not found Контакт с указанным ID не найден
      500 System Error
      Sample:
      Request:
      GET /v2.0/contact/omni7 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "data": { "address": "Big Sea 23", "city": "Nikolaev", "company": "Omnilance", "country": "UA", "fax": "380.99999999", "mail": "contact@example.com", "name": "Contact Name", "phone": "380.99999999", "region": "Nikolaevskaya", "zip": "54000" }, "status": true }
    • Проверка на доступность

      no implementation for this version
      Проверка идентификатора контакта на доступность к созданию
      Request:
      Resource:
      https://api.omnilance.com/{version}/contact/{contact_id}/check
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      contact_id string Contact's ID
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Список параметров ответа
      "avail": boolean, True — если контак доступен, False- если не доступен
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Invalid {{ param_name }} Неверно задан параметр
      403 Authorization failed Неверно указан токен
      403 Token not found В заголовках не передан токен
      500 System Error
      Sample:
      Request:
      GET /v2.0/contact/omni7/check HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "avail": true, "code": 200, "status": true }
    • Редактирование контакта

      no implementation for this version
      Редактирование контакта
      Request:
      Resource:
      https://api.omnilance.com/{version}/contact/{contact_id}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      contact_id string Contact's ID
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Body:
      Contact Список параметров запроса
      Response:
      Body:
      { Список параметров ответа
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Invalid Param Недопустимый идентификатор контакта
      400 Not enough parameter: {{ info }} Указаны не все обязательные параметры
      403 Authorization failed Неверно указан токен
      403 Token not found В заголовках не передан токен
      404 ID not found Контакт с указанным ID не найден
      500 System Error
      Sample:
      Request:
      PUT /v2.0/contact/omni7 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg== { "address": "Big Sea 23", "city": "Nikolaev", "company": "Omnilance", "country": "UA", "fax": "380.99999999", "mail": "contact@example.com", "name": "Contact Name", "phone": "380.99999999", "region": "Nikolaevskaya", "zip": "54000" }
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true }
    • Создание контакта

      no implementation for this version
      Создание контакта
      Request:
      Resource:
      https://api.omnilance.com/{version}/contact/{contact_id}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      contact_id string Contact's ID
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Body:
      { Список параметров запроса
      "address": string, Адрес контакта
      "city": string, Город контакта
      "company": string, Название организации
      "country": string, Страна контакта
      "customer_id": integer, ID-клиента которому необходимо создать контакт
      "fax": string, Факс контакта
      "mail": string, E-mail адресс контакта
      "name": string, Имя контакта
      "phone": string, Телефон контакта
      "region": string, Область контакта
      "zip": string Индекс контакта
      }
      Response:
      Body:
      { Список параметров ответа
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Extra param {{ info }} unknown Дополнительный параметр неизвестен
      400 Invalid value for extra param {{ info }} Недопустимое значение для дополнительного параметра
      400 Not enough parameter: {{ info }} Указаны не все обязательные параметры
      403 Authorization failed Неверно указан токен
      403 Token not found В заголовках не передан токен
      500 System Error
      Sample:
      Request:
      POST /v2.0/contact/omni7 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg== { "address": "Big Sea 23", "city": "Nikolaev", "company": "Omnilance", "country": "UA", "customer_id": 29876, "fax": "380.99999999", "mail": "contact@example.com", "name": "Contact Name", "phone": "380.99999999", "region": "Nikolaevskaya", "zip": "54000" }
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true }
    • Удаление контакта

      no implementation for this version
      Удаление контакта
      Request:
      Resource:
      https://api.omnilance.com/{version}/contact/{contact_id}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      contact_id string Contact's ID
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      {
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      403 Authorization failed Неверно указан токен
      403 This object linked Контакт связан с доменом
      403 Token not found В заголовках не передан токен
      404 ID not found Контакт с указанным ID не найден
      500 System Error
      Sample:
      Request:
      DELETE /v2.0/contact/omni7 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true }
  • Домены

    Управление доменами
    • Восстановление домена

      no implementation for this version
      Восстановление домена
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/restore
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Пример ответа
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Не поддерживается доменная зона
      400 Invalid id Неверный ID
      400 Not the correct domain name Неправильное доменное имя
      403 Authorization failed Неверно указан токен
      403 Not enough funds on the balance sheet Недостаточно средств на балансе
      403 The status of the order does not allow to perform the operation Статус заказа не позволяет выполнить операцию
      403 Token not found В заголовках не передан токен
      500 System Error
      Sample:
      Request:
      PUT /v2.0/domain/example.com/restore HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true }
    • Информация о домене

      no implementation for this version
      Получение информации о домене
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      Codes:
      Code Message Description
      400 Domain zone not support Не поддерживается доменная зона
      400 Not the correct domain name Неправильное доменное имя
      403 Authorization failed Неверно указан токен
      403 Token not found В заголовках не передан токен
      404 Object not found {{ info }} Объект не найден
      500 System Error
      Sample:
      Request:
      GET /v2.0/domain/example.com HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "contact_admin": "omni777", "contact_billing": "omni777", "contact_registrant": "omni777", "contact_tech": "omni777", "date_created": "2015-12-04 19:40:21", "date_end": "2016-12-04 19:40:21", "ns": [ "ns1.rx-name.net", "ns1.rx-name.net" ], "status": "2" }
    • Проверка домена

      no implementation for this version
      Проверка домена на доступность к регистрации
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/check
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Пример ответа
      "avail": string, True — если домен доступен, False- если не доступен
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Не поддерживается доменная зона
      400 Not the correct domain name Неправильное доменное имя
      403 Authorization failed Неверно указан токен
      403 Token not found В заголовках не передан токен
      500 System Error
      Sample:
      Request:
      GET /v2.0/domain/example.com/check HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "avail": "my_avail", "code": 200, "status": true }
    • Продление домена

      no implementation for this version
      Продление домена
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/renew
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Body:
      { Список параметров запроса
      "current_expiry_date": string, Текущий срок окончания регистрации домена. Этот элемент гарантирует, что при случайном повторе команды не произойдет несанкционированного продления срока регистрации
      "date_end": string, Новая дата и время окончания регистрации домена.
      "domain": string, Доменное имя
      "period": integer Количество лет, на которые продлевается срок регистрации. Максимальное значения определяется правилами соответствующего публичного домена.
      }
      Response:
      Body:
      { Пример ответа
      "code": integer,
      "data": {
      "date_end": string,
      "domain": string
      },
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Не поддерживается доменная зона
      400 Invalid id Неверный ID
      400 Not enough parameter: {{ info }} Указаны не все обязательные параметры
      400 Not the correct current_expiry_date Неверное значение current_expiry_date
      400 Not the correct domain name Неправильное доменное имя
      400 maximum value period: {{ info }} Максимальное значение периода
      400 minimum value period: {{ info }} Минимальное значение периода
      403 Authorization failed Неверно указан токен
      403 Not enough funds on the balance sheet Недостаточно средств на балансе
      403 The status of the order does not allow to perform the operation Статус заказа не позволяет выполнить операцию
      403 Token not found В заголовках не передан токен
      500 System Error
      Sample:
      Request:
      PUT /v2.0/domain/example.com/renew HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg== { "current_expiry_date": "2016-12-03", "date_end": "2017-12-04 19:40:21", "domain": "example.com", "period": 1 }
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "data": { "date_end": "2017-12-04 19:40:21", "domain": "example.com" }, "status": true }
    • Регистрация домена

      no implementation for this version
      Регистрация домена
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Body:
      {
      "contact_admin": string, ID-контакта администратора домена
      "contact_billing": string, ID-контакта отвественного по финансовым вопросам
      "contact_registrant": string, ID-контакта владельца домена
      "contact_tech": string, ID-контакта ответственного по техническим вопросам
      "customer_id": integer, ID-клиента которому требуется создать заказ(только для режима реселлер)
      "ns": { Массив с списком NS-серверов для домена
      "array": [
      string
      ]
      },
      "period": integer Количество лет для регистрации домена
      }
      Response:
      Body:
      {
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Не поддерживается доменная зона
      400 Invalid id Неверный ID
      400 Not enough parameter: {{ info }} Указаны не все обязательные параметры
      400 Not the correct domain name Неправильное доменное имя
      400 Not the correct license Неверная лицензия
      400 Not the correct ns: {{ info }} Неверные NS
      400 maximum value period: {{ info }} Максимальное значение периода
      400 minimum value period: {{ info }} Минимальное значение периода
      403 Authorization failed Неверно указан токен
      403 Domain is already registered Домен уже зарегистрирован
      403 Not enough funds on the balance sheet Недостаточно средств на балансе
      403 Token not found В заголовках не передан токен
      500 System Error
      Sample:
      Request:
      POST /v2.0/domain/example.com HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg== { "contact_admin": "omni7", "contact_billing": "omni7", "contact_registrant": "omni7", "contact_tech": "omni7", "customer_id": 19851, "ns": { "array": [ "ns1.rx-name.net", "ns1.rx-name.net" ] }, "period": 1 }
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true }
    • Редактирование домена

      no implementation for this version
      Редактирование домена
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Body:
      { Список параметров запроса
      "client_delete_prohibited": integer, Значения «0» - удалить статус, «1» - установить статус
      "client_hold": integer, Значения «0» - удалить статус, «1» - установить статус
      "client_renew_prohibited": integer, Значения «0» - удалить статус, «1» - установить статус
      "client_transfer_prohibited": integer, Значения «0» - удалить статус, «1» - установить статус
      "client_update_prohibited": integer, Значения «0» - удалить статус, «1» - установить статус
      "contact_admin": string, ID-контакта администратора домена
      "contact_billing": string, ID-контакта отвественного по финансовым вопросам
      "contact_registrant": string, ID-контакта владельца домена
      "contact_tech": string, ID-контакта ответственного по техническим вопросам
      "ns": { Массив с списком NS-серверов для домена, соддержит внутри себя 2 массива, del и add внутри которых находятся NS-сервера, в массиве с индексом del — те которые необходимо
      "add": [
      string
      ],
      "del": [
      string
      ]
      }
      }
      Response:
      Body:
      { Пример ответа
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Не поддерживается доменная зона
      400 Invalid id Неверный ID
      400 Not enough parameter: {{ info }} Указаны не все обязательные параметры
      400 Not the correct domain name Неправильное доменное имя
      400 Not the correct ns: {{ info }} Неверные NS
      400 Not the correct {{ param_name }} Неверный параметр
      403 Authorization failed Неверно указан токен
      403 Not enough funds on the balance sheet Недостаточно средств на балансе
      403 Token not found В заголовках не передан токен
      500 System Error
      Sample:
      Request:
      PUT /v2.0/domain/example.com HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg== { "client_delete_prohibited": 1, "client_hold": 1, "client_renew_prohibited": 1, "client_transfer_prohibited": 1, "client_update_prohibited": 1, "contact_admin": "omni1", "contact_billing": "omni1", "contact_registrant": "omni1", "contact_tech": "omni1", "ns": { "add": [ "ns2.rx-name.net", "ns2.rx-name.net" ], "del": [ "ns1.rx-name.net", "ns1.rx-name.net" ] } }
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true }
    • Список доменных зон

      no implementation for this version
      Список доменных зон
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/zones/{type}/limit/{limit}/start/{start}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      type stringOptional popular или international или ukrainian или new
      limit integerOptional Лимит число
      start integerOptional Старт число
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      {
      "code": integer,
      "data": Zones,
      "status": boolean
      }
      Codes:
      Code Message Description
      403 Authorization failed Неверно указан токен
      403 Token not found В заголовках не передан токен
      500 System Error
      Sample:
      Request:
      GET /v2.0/domain/zones/my_type/limit/10/start/10 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "data": { "date_end_reg_action": "2017-01-15 23:59:59", "date_end_renew_action": "2017-01-15 23:59:59", "idn_avail": false, "max_length": 10, "min_length": 1, "price_reg": 44, "price_reg_action": 20, "price_renew": 44, "price_renew_action": 20, "price_restore": 250, "price_transfer": 44, "transfer_avail": true, "zone": "UA" }, "status": true }
    • Удаление домена

      no implementation for this version
      Удаление домена
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Пример ответа
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Не поддерживается доменная зона
      400 Invalid id Неверный ID
      400 Not the correct domain name Неправильное доменное имя
      403 Authorization failed Неверно указан токен
      403 The status of the order does not allow to perform the operation Статус заказа не позволяет выполнить операцию
      403 Token not found В заголовках не передан токен
      500 System Error
      Sample:
      Request:
      DELETE /v2.0/domain/example.com HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true }
  • Трансфер

    Трансфер доменов
    • Отмена трансфера к ua.rx

      no implementation for this version
      Отмена заказа трансфера домена к Omnilance
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/transfer
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Пример ответа
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Invalid id Неверный ID
      400 Not the correct domain name Неправильное доменное имя
      403 Authorization failed Неверно указан токен
      403 The status of the order does not allow to perform the operation Статус заказа не позволяет выполнить операцию
      403 Token not found В заголовках не передан токен
      404 Object not found {{ info }} Объект не найден
      500 System Error
      Sample:
      Request:
      DELETE /v2.0/domain/example.com/transfer HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true }
    • Отмена трансфера от ua.rx

      no implementation for this version
      Отмена трансфера домена к другому регистратору
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/transfer/reject
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Пример ответа
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Invalid id Неверный ID
      400 Not the correct domain name Неправильное доменное имя
      403 Authorization failed Неверно указан токен
      403 The status of the order does not allow to perform the operation Статус заказа не позволяет выполнить операцию
      403 Token not found В заголовках не передан токен
      404 Object not found {{ info }} Объект не найден
      500 System Error
      Sample:
      Request:
      PUT /v2.0/domain/example.com/transfer/reject HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true }
    • Подтверждение трансфера от ua.rx

      no implementation for this version
      Подтверждение трансфера домена к другому регистратору
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/transfer/approve
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Пример ответа
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Invalid id Неверный ID
      400 Not the correct domain name Неправильное доменное имя
      403 Authorization failed Неверно указан токен
      403 The status of the order does not allow to perform the operation Статус заказа не позволяет выполнить операцию
      403 Token not found В заголовках не передан токен
      404 Object not found {{ info }} Объект не найден
      500 System Error
      Sample:
      Request:
      PUT /v2.0/domain/example.com/transfer/approve HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true }
    • Статус трансфера

      no implementation for this version
      Получение статуса трансфера домена
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/transfer
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Список параметров ответа
      "code": integer,
      "status": boolean,
      "transfer_status": string Статус трансфера
      }
      Codes:
      Code Message Description
      400 Invalid id Неверный ID
      400 Not the correct domain name Неправильное доменное имя
      403 Authorization failed Неверно указан токен
      403 The status of the order does not allow to perform the operation Статус заказа не позволяет выполнить операцию
      403 Token not found В заголовках не передан токен
      404 Object not found {{ info }} Объект не найден
      500 System Error
      Sample:
      Request:
      GET /v2.0/domain/example.com/transfer HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true, "transfer_status": "pending" }
    • Трансфер домена

      no implementation for this version
      Запрос на трансфер домена
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/transfer
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Body:
      { Список параметров запроса
      "customer_id": integer, ID пользователя которому присваивается заказ
      "transfer_code": string Код для трансфера
      }
      Response:
      Body:
      { Пример ответа
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Не поддерживается доменная зона
      400 Invalid id Неверный ID
      400 Not the correct domain name Неправильное доменное имя
      400 Not the correct transfer_code Неверное значение transfer_code
      403 Authorization failed Неверно указан токен
      403 Not enough funds on the balance sheet Недостаточно средств на балансе
      403 Token not found В заголовках не передан токен
      500 System Error
      Sample:
      Request:
      POST /v2.0/domain/example.com/transfer HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg== { "customer_id": 2377, "transfer_code": "1cdc@%)s$fd" }
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true }
  • Хосты

    Управление хостами
    • Информация по хосту

      no implementation for this version
      Получение информации по хосту
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/host/{host_name}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      host_name string Хост
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Список параметров ответа
      "code": integer,
      "data": {
      "ip": [ Массив со списком ip-адресов хоста
      string
      ],
      "name": string Имя хоста
      },
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Не поддерживается доменная зона
      403 Authorization failed Неверно указан токен
      403 The status of the order does not allow to perform the operation Статус заказа не позволяет выполнить операцию
      403 Token not found В заголовках не передан токен
      404 Object not found {{ info }} Объект не найден
      500 System Error
      Sample:
      Request:
      GET /v2.0/domain/example.com/host/ns1 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "data": { "ip": [ "192.168.0.1", "192.168.0.1" ], "name": "ns1.example.ua" }, "status": true }
    • Проверка хоста

      no implementation for this version
      Проверка хоста на доступность к созданию
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/host/{host_name}/check
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      host_name string Хост
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Список параметров ответа
      "avail": boolean, True — если хост доступен, False- если не доступен
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Не поддерживается доменная зона
      403 Authorization failed Неверно указан токен
      403 Order not support this action Заказ не поддерживает это действие
      403 The status of the order does not allow to perform the operation Статус заказа не позволяет выполнить операцию
      403 Token not found В заголовках не передан токен
      404 Object not found {{ info }} Объект не найден
      500 System Error
      Sample:
      Request:
      GET /v2.0/domain/example.com/host/ns1/check HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "avail": true, "code": 200, "status": true }
    • Редактирование хоста

      no implementation for this version
      Редактирование хоста
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/host/{host_name}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      host_name string Хост
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Body:
      { Список параметров запроса
      "ip": { Массив со списком ip-адресов для хоста, соддержит внутри себя 2 массива, del и add внутри которых находятся ip-адреса, в массиве с индексом del — те которые необходимо удалить, add- те которые необходимо добавить
      "add": [
      string
      ],
      "del": [
      string
      ]
      }
      }
      Response:
      Body:
      { Список параметров ответа
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Не поддерживается доменная зона
      400 Not the correct IPv4: {{ info }} Не корректный адрес IPv4"
      400 Not the correct IPv6: {{ info }} Не корректный адрес IPv6
      400 Unknown ip type : {{ info }} Не корректно указан тип. Тип должен быть v4 или v6
      403 Authorization failed Неверно указан токен
      403 Order not support this action Заказ не поддерживает это действие
      403 The status of the order does not allow to perform the operation Статус заказа не позволяет выполнить операцию
      403 Token not found В заголовках не передан токен
      404 Object not found {{ info }} Объект не найден
      500 System Error
      Sample:
      Request:
      PUT /v2.0/domain/example.com/host/ns1 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg== { "ip": { "add": [ "type=>v4,ip=>192.168.0.1", "type=>v4,ip=>192.168.0.1" ], "del": [ "type=>v4,ip=>127.0.0.1", "type=>v4,ip=>127.0.0.1" ] } }
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true }
    • Создание хоста

      no implementation for this version
      Создание хоста
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/host/{host_name}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      host_name string Хост
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Body:
      { Список параметров запроса
      "ip": [
      {
      "ip": string,
      "type": string v4 или v6
      }
      ]
      }
      Response:
      Body:
      { Список параметров ответа
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Не поддерживается доменная зона
      400 Not enough parameter: {{ info }} Указаны не все обязательные параметры
      400 Not the correct IPv4: {{ info }} Не корректный адрес IPv4
      400 Not the correct IPv6: {{ info }} Не корректный адрес IPv6
      400 Unknown ip type : {{ info }} Не корректно указан тип. Тип должен быть v4 или v6
      403 Authorization failed Неверно указан токен
      403 Order not support this action Заказ не поддерживает это действие
      403 The status of the order does not allow to perform the operation Статус заказа не позволяет выполнить операцию
      403 Token not found В заголовках не передан токен
      404 Object not found {{ info }} Объект не найден
      500 System Error
      Sample:
      Request:
      POST /v2.0/domain/example.com/host/ns1 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg== { "ip": [ { "ip": "127.0.0.1", "type": "v4" }, { "ip": "127.0.0.1", "type": "v4" } ] }
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true }
    • Удаление хоста

      no implementation for this version
      Удаление хоста
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/host/{host_name}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Доменное имя
      host_name string Хост
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Список параметров ответа
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Не поддерживается доменная зона
      403 Authorization failed Неверно указан токен
      403 The status of the order does not allow to perform the operation Статус заказа не позволяет выполнить операцию
      403 Token not found В заголовках не передан токен
      404 Object not found {{ info }} Объект не найден
      500 System Error
      Sample:
      Request:
      DELETE /v2.0/domain/example.com/host/ns1 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Auth-Token: aHR0cHM6Ly9teS5yeC1uYW1lLnVhL3Byb2ZpbGUvYXBpCg==
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true }
  • Клиенты

    Управление клиентами
    • Customer

      no implementation for this version
      Клиент
      Presentation:
      {
      "address": string, Адрес клиента
      "city": string, Город клиента
      "company": string, Компания
      "country": string, Двухзначный код страны
      "fax": string, Факс клиента
      "lang": string, Двухзначный код локализации клиента
      "mail": string, E-mail клиента
      "name": string, Имя клиента
      "password": string, Пароль клиента
      "phone": string, Телефон клиента
      "post_adress": string, Почтовый адресс клиента
      "region": string, Область клиента
      "zip": integer Почтовый индекс клиента
      }
      Formats:
      Sample:
      { "address": "Адрес клиента", "city": "Город клиента", "company": "Компания", "country": "UA", "fax": "380.631234567", "lang": "en", "mail": "customer@email.com", "name": "Имя клиента", "password": "1cdc@%)s$fd", "phone": "380.631234567", "post_adress": "Почтовый адресс клиента", "region": "Область клиента", "zip": 54000 }
  • Контакты

    Управление контактами
    • Contact

      no implementation for this version
      Контакт
      Presentation:
      {
      "address": string, Адрес контакта
      "city": string, Город контакта
      "company": string, Название организации
      "country": string, Страна контакта
      "fax": string, Факс контакта
      "mail": string, E-mail адресс контакта
      "name": string, Имя контакта
      "phone": string, Телефон контакта
      "region": string, Область контакта
      "zip": string Индекс контакта
      }
      Formats:
      Sample:
      { "address": "Big Sea 23", "city": "Nikolaev", "company": "Omnilance", "country": "UA", "fax": "380.99999999", "mail": "contact@example.com", "name": "Contact Name", "phone": "380.99999999", "region": "Nikolaevskaya", "zip": "54000" }
  • Домены

    Управление доменами
    • Domain

      no implementation for this version
      Домен
      Presentation:
      {
      "contact_admin": string, ID-контакта администратора домена
      "contact_billing": string, ID-контакта отвественного по финансовым вопросам
      "contact_registrant": string, ID-контакта владельца домена
      "contact_tech": string, ID-контакта ответственного по техническим вопросам
      "date_created": string, Дата начала заказа домена
      "date_end": string, Дата завершения срока делегирования
      "ns": [ Массив сo списком NS-серверов для домена
      string
      ],
      "status": string Статус заказа: '0' - Заявка, '1' - В обработке, '2' - Активен, '3' - Просрочен, '6' - Удаление
      }
      Formats:
      Sample:
      { "contact_admin": "omni777", "contact_billing": "omni777", "contact_registrant": "omni777", "contact_tech": "omni777", "date_created": "2015-12-04 19:40:21", "date_end": "2016-12-04 19:40:21", "ns": [ "ns1.rx-name.net", "ns1.rx-name.net" ], "status": "2" }
    • Zones

      no implementation for this version
      Доменная зона
      Presentation:
      {
      "date_end_reg_action": string, Дата завершения акции для регистрации
      "date_end_renew_action": string, Дата завершения акции для продления
      "idn_avail": boolean, Поддержка IDN
      "max_length": integer, Максимальное количество лет для регистрации
      "min_length": integer, Минимальное количество лет для регистрации
      "price_reg": number, Цена регистрации
      "price_reg_action": number, Аукционная цена регистрации
      "price_renew": number, Цена продления
      "price_renew_action": number, Аукционная цена продления
      "price_restore": number, Цена восстановления
      "price_transfer": number, Цена трансфера
      "transfer_avail": boolean, Доступность трансфера
      "zone": string Имя зоны
      }
      Formats:
      Sample:
      { "date_end_reg_action": "2017-01-15 23:59:59", "date_end_renew_action": "2017-01-15 23:59:59", "idn_avail": false, "max_length": 10, "min_length": 1, "price_reg": 44, "price_reg_action": 20, "price_renew": 44, "price_renew_action": 20, "price_restore": 250, "price_transfer": 44, "transfer_avail": true, "zone": "UA" }
  • Versions

    • Version

      no implementation for this version
      A current version
      Presentation:
      string
      Formats:
      Pretty Print:
      VN.N
      Advanced:
      V\d+\.\d+
      Sample:
      "v2.0"