Omnilance REST API

API documentation

hello
  • Costomers

    Customers manage
    • Customer Create

      no implementation for this version
      Add new customer
      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 Data new customer
      Response:
      Body:
      { Response API
      "code": integer, Response code
      "data": {
      "customer_id": integer ID added customer
      },
      "status": boolean Response status
      }
      Codes:
      Code Message Description
      400 Invalid {{ param_name }} Invalid parameter
      403 Authorization failed Invalid token
      403 Mail already registered Mail already registered
      403 Token not found 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": "Big Sea 23", "city": "Mykolaiv", "company": "Omnilance", "country": "UA", "fax": "380.631234567", "lang": "en", "mail": "customer@email.com", "name": "John Doe", "password": "1cdc@%)s$fd", "phone": "380.631234567", "post_adress": "Big Sea 23, 41", "region": "Mykolaivska", "zip": 54000 }
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "data": { "customer_id": 1 }, "status": true }
    • Customer Delete

      no implementation for this version
      Customer delete
      Request:
      Resource:
      https://api.omnilance.com/{version}/customer/{customer_id}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      customer_id integer Customer's 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 Invalid token
      403 Token not found Token not found
      403 You can not delete the contact has active orders You can not delete the contact has active orders
      404 ID not found 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 }
    • Customer Edit

      no implementation for this version
      Customer edit
      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 Edit customer info
      Response:
      Body:
      { Ответ API
      "code": integer, Response code
      "status": boolean Response status
      }
      Codes:
      Code Message Description
      400 Invalid {{ param_name }} Invalid parameter
      403 Authorization failed Invalid token
      403 Token not found Token not found
      404 ID not found 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": "Big Sea 23", "city": "Mykolaiv", "company": "Omnilance", "country": "UA", "fax": "380.631234567", "lang": "en", "mail": "customer@email.com", "name": "John Doe", "password": "1cdc@%)s$fd", "phone": "380.631234567", "post_adress": "Big Sea 23, 41", "region": "Mykolaivska", "zip": 54000 }
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "code": 200, "status": true }
    • Customer Info

      no implementation for this version
      Get info about customer
      Request:
      Resource:
      https://api.omnilance.com/{version}/customer/{customer_id}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      customer_id integer Customer's ID
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Samle response
      "data": {
      "address": string, Customer's address
      "city": string, Customer's city
      "company": string, Customer's company
      "count_active_orders": integer, Active orders
      "country": string, Two symbols country code
      "id": integer, Customer's ID
      "mail": string, Customer's E-mail
      "name": string, Customer's full name
      "phone": string, Customer's phone number
      "region": string, Customer's region
      "zip": integer Zip code
      },
      "status": boolean Request status
      }
      Codes:
      Code Message Description
      400 Invalid {{ param_name }} Invalid parameter
      403 Authorization failed Invalid token
      403 Token not found Token not found
      404 ID not found 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 }
  • Contacts

    Contacts manage
    • Availability Check

      no implementation for this version
      Availability contact check to create
      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:
      { List of response parameters
      "avail": boolean, True — if contact available, False - if not available
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Invalid {{ param_name }} Invalid parameter
      403 Authorization failed Invalid token
      403 Token not found 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 }
    • Contact Create

      no implementation for this version
      Contact create
      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:
      { List of request parameters
      "address": string, Contact address
      "city": string, Contact's city
      "company": string, Company name
      "country": string, Contact's country
      "customer_id": integer, ID client to create a contact
      "fax": string, Contact's fax
      "mail": string, Contact's E-mail
      "name": string, Contact Name
      "phone": string, Contact's phone
      "region": string, Contact's region
      "zip": string Zip code
      }
      Response:
      Body:
      { List of response parameters
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Extra param {{ info }} unknown Extra parameter unknown
      400 Invalid value for extra param {{ info }} Invalid value for extra parameter
      400 Not enough parameter: {{ info }} Not enough parameters
      403 Authorization failed Invalid token
      403 Token not found 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 }
    • Contact Delete

      no implementation for this version
      Contact delete
      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:
      { List of response parameters
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      403 Authorization failed Invalid token
      403 This object linked This object linked
      403 Token not found Token not found
      404 ID not found ID not found
      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 }
    • Contact Edit

      no implementation for this version
      Contact edit
      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 List of request parameters
      Response:
      Body:
      { List of response parameters
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Not enough parameter: {{ info }} Not enough parameters
      403 Authorization failed Invalid token
      403 Token not found Token not found
      404 ID not found ID not found
      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 }
    • Contact Info

      no implementation for this version
      Get info by contact
      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:
      { List of response parameters
      "code": integer,
      "data": Contact,
      "status": boolean
      }
      Codes:
      Code Message Description
      403 Authorization failed Invalid token
      403 Token not found Token not found
      404 ID not found ID not found
      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 }
  • Domains

    Domains manage
    • Domain Check

      no implementation for this version
      Domain check to register
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/check
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Domain name
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Sample response
      "avail": string, True — if domain not registered False - if domain register
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Domain zone not support
      400 Not the correct domain name Not the correct domain name
      403 Authorization failed Invalid token
      403 Token not found 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 }
    • Domain Delete

      no implementation for this version
      Domain delete
      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:
      { Sample response
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Domain zone not support
      400 Invalid id Invalid ID
      400 Not the correct domain name Not the correct domain name
      403 Authorization failed Invalid token
      403 The status of the order does not allow to perform the operation The status of the order does not allow to perform the operation
      403 Token not found 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 }
    • Domain Edit

      no implementation for this version
      Domain edit
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Domain name
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Body:
      { List of request parameters
      "client_delete_prohibited": integer, Values '0' - delete the status, '1' - set the status
      "client_hold": integer, Values '0' - delete the status, '1' - set the status
      "client_renew_prohibited": integer, Values '0' - delete the status, '1' - set the status
      "client_transfer_prohibited": integer, Values '0' - delete the status, '1' - set the status
      "client_update_prohibited": integer, Values '0' - delete the status, '1' - set the status
      "contact_admin": string, Domain admin contact ID
      "contact_billing": string, Domain billing contact ID
      "contact_registrant": string, Domain registrant contact ID
      "contact_tech": string, Domain tech contact ID
      "ns": { An array with a list of NS-servers for the domain, contains two arrays, del and add inside which are NS-servers, in an array with the index del-those that are necessary
      "add": [
      string
      ],
      "del": [
      string
      ]
      }
      }
      Response:
      Body:
      { Sample response
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Domain zone not support
      400 Invalid id Invalid ID
      400 Not enough parameter: {{ info }} Not enough parameter
      400 Not the correct domain name Not the correct domain name
      400 Not the correct ns: {{ info }} Not the correct NS
      400 Not the correct {{ param_name }} Not the correct parametr
      403 Authorization failed Invalid token
      403 Not enough funds on the balance sheet Not enough funds on the balance sheet
      403 Token not found 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 }
    • Domain Info

      no implementation for this version
      Get info about domain
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Domain name
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      Codes:
      Code Message Description
      400 Domain zone not support Domain zone not support
      400 Not the correct domain name Not the correct domain name
      403 Authorization failed Invalid token
      403 Token not found Token not found
      404 Object not found {{ info }} Object not found
      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" }
    • Domain Registration

      no implementation for this version
      Domain registeration
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Domain name
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Body:
      {
      "contact_admin": string, Domain admin contact ID
      "contact_billing": string, Domain billing contact ID
      "contact_registrant": string, Domain registrant contact ID
      "contact_tech": string, Domain tech contact ID
      "customer_id": integer, ID client to create an order (only for reseller mode)
      "ns": { Nameservers array for domain registration
      "array": [
      string
      ]
      },
      "period": integer Years count for registration domain
      }
      Response:
      Body:
      {
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Domain zone not support
      400 Invalid id Invalid ID
      400 Not enough parameter: {{ info }} Not enough parameter
      400 Not the correct domain name Not the correct domain name
      400 Not the correct license Not the correct license
      400 Not the correct ns: {{ info }} Not the correct NS
      400 maximum value period: {{ info }} Not the correct maximum value period
      400 minimum value period: {{ info }} Not the correct minimum value period
      403 Authorization failed Invalid token
      403 Domain is already registered Domain is already registered
      403 Not enough funds on the balance sheet Not enough funds on the balance sheet
      403 Token not found 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 }
    • Domain Renew

      no implementation for this version
      Domain renew
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/renew
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Domain name
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Body:
      { List of request parameters
      "current_expiry_date": string, Current deadline for domain registration. This element ensures that if the command is accidentally repeated, there will be no unauthorized renewal of the registration term
      "date_end": string, New date and time of the end of domain registration.
      "domain": string, Domain name
      "period": integer Number of years for which the deadline for registration is extended. The maximum value is determined by the rules of the corresponding public domain.
      }
      Response:
      Body:
      { Sample response
      "code": integer,
      "data": {
      "date_end": string,
      "domain": string
      },
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Domain zone not support
      400 Invalid id Invalid ID
      400 Not enough parameter: {{ info }} Not enough parameter
      400 Not the correct current_expiry_date Not the correct current_expiry_date
      400 Not the correct domain name Not the correct domain name
      400 maximum value period: {{ info }} Not the correct maximum value period
      400 minimum value period: {{ info }} Not the correct minimum value period
      403 Authorization failed Invalid token
      403 Not enough funds on the balance sheet Not enough funds on the balance sheet
      403 The status of the order does not allow to perform the operation The status of the order does not allow to perform the operation
      403 Token not found 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 }
    • Domain Restore

      no implementation for this version
      Domain restore
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/restore
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Domain name
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Sample response
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Domain zone not support
      400 Invalid id Invalid ID
      400 Not the correct domain name Not the correct domain name
      403 Authorization failed Invalid token
      403 Not enough funds on the balance sheet Not enough funds on the balance sheet
      403 The status of the order does not allow to perform the operation The status of the order does not allow to perform the operation
      403 Token not found 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 }
    • Domain Zones

      no implementation for this version
      List of Domain Zones
      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 string popular or international or ukrainian or new
      limit integer Limit number
      start integer Start number
      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 Invalid token
      403 Token not found Token not found
      500 System Error
      Sample:
      Request:
      GET /v2.0/domain/zones/ukrainian/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 }
  • Transfer

    Domains transfer
    • Transfer Approve

      no implementation for this version
      Approve domain transfer to another registrar
      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 Domain name
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Sample response
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Invalid id Invalid ID
      400 Not the correct domain name Not the correct domain name
      403 Authorization failed Invalid token
      403 The status of the order does not allow to perform the operation The status of the order does not allow to perform the operation
      403 Token not found Token not found
      404 Object not found {{ info }} Object not found
      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 }
    • Transfer Cancel

      no implementation for this version
      Cancellation of domain transfer order
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/transfer
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Domain name
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Sample response
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Invalid id Invalid ID
      400 Not the correct domain name Not the correct domain name
      403 Authorization failed Invalid token
      403 The status of the order does not allow to perform the operation The status of the order does not allow to perform the operation
      403 Token not found Token not found
      404 Object not found {{ info }} Object not found
      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 }
    • Transfer Reject

      no implementation for this version
      Reject domain transfer to another registrar
      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 Domain name
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { Sample response
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Invalid id Invalid ID
      400 Not the correct domain name Not the correct domain name
      403 Authorization failed Invalid token
      403 The status of the order does not allow to perform the operation The status of the order does not allow to perform the operation
      403 Token not found Token not found
      404 Object not found {{ info }} Object not found
      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 }
    • Transfer Request

      no implementation for this version
      Domain transfer request
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/transfer
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Domain name
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Body:
      { List of request parameters
      "customer_id": integer, The user ID to which the order is assigned
      "transfer_code": string Auth transfer code
      }
      Response:
      Body:
      { Sample response
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Domain zone not support
      400 Invalid id Invalid ID
      400 Not the correct domain name Not the correct domain name
      400 Not the correct transfer_code Not the correct transfer_code
      403 Authorization failed Invalid token
      403 Not enough funds on the balance sheet Not enough funds on the balance sheet
      403 Token not found 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 }
    • Transfer Status

      no implementation for this version
      Getting the status of a domain transfer
      Request:
      Resource:
      https://api.omnilance.com/{version}/domain/{domain_name}/transfer
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      domain_name string Domain name
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { List of response parameters
      "code": integer,
      "status": boolean,
      "transfer_status": string Transfer status
      }
      Codes:
      Code Message Description
      400 Invalid id Invalid ID
      400 Not the correct domain name Not the correct domain name
      403 Authorization failed Invalid token
      403 The status of the order does not allow to perform the operation The status of the order does not allow to perform the operation
      403 Token not found Token not found
      404 Object not found {{ info }} Object not found
      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" }
  • Hosts

    Hosts manage
    • Host Check

      no implementation for this version
      Checking the host for accessibility to the creation
      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 Domain name
      host_name string Host
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { List of response parameters
      "avail": boolean, True - if the host is available, False - if not available
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Domain zone not support
      403 Authorization failed Invalid token
      403 Order not support this action Order not support this action
      403 The status of the order does not allow to perform the operation The status of the order does not allow to perform the operation
      403 Token not found Token not found
      404 Object not found {{ info }} Object not found
      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 }
    • Host Create

      no implementation for this version
      Host Create
      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 Domain name
      host_name string Host
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Body:
      { List of request parameters
      "ip": [
      {
      "ip": string,
      "type": string v4 or v6
      }
      ]
      }
      Response:
      Body:
      { List of response parameters
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Domain zone not support
      400 Not enough parameter: {{ info }} Not enough parameter
      400 Not the correct IPv4: {{ info }} Not the correct IPv4
      400 Not the correct IPv6: {{ info }} Not the correct IPv6
      400 Unknown ip type : {{ info }} Unknown ip type expected v4 or v6
      403 Authorization failed Invalid token
      403 Order not support this action Order not support this action
      403 The status of the order does not allow to perform the operation The status of the order does not allow to perform the operation
      403 Token not found Token not found
      404 Object not found {{ info }} Object not found
      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 }
    • Host Delete

      no implementation for this version
      Host Delete
      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 Domin name
      host_name string Host
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { List of response parameters
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Domain zone not support
      403 Authorization failed Invalid token
      403 The status of the order does not allow to perform the operation The status of the order does not allow to perform the operation
      403 Token not found Token not found
      404 Object not found {{ info }} Object not found
      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 }
    • Host Edit

      no implementation for this version
      Host Edit
      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 Domain name
      host_name string Host
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Body:
      { List of request parameters
      "ip": { Массив со списком ip-адресов для хоста, соддержит внутри себя 2 массива, del и add внутри которых находятся ip-адреса, в массиве с индексом del — те которые необходимо удалить, add- те которые необходимо добавить
      "add": [
      string
      ],
      "del": [
      string
      ]
      }
      }
      Response:
      Body:
      { List of response parameters
      "code": integer,
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Domain zone not support
      400 Not the correct IPv4: {{ info }} Not the correct IPv4
      400 Not the correct IPv6: {{ info }} Not the correct IPv6
      400 Unknown ip type : {{ info }} Unknown ip type expected v4 or v6
      403 Authorization failed Invalid token
      403 Order not support this action Order not support this action
      403 The status of the order does not allow to perform the operation The status of the order does not allow to perform the operation
      403 Token not found Token not found
      404 Object not found {{ info }} Object not found
      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 }
    • Host Info

      no implementation for this version
      Get information about host
      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 Domain name
      host_name string Хост
      Headers:
      Parameter Type Description
      X-Auth-Token string Authentication token
      Response:
      Body:
      { List of response parameters
      "code": integer,
      "data": {
      "ip": [ An array with a list of ip-addresses of the host
      string
      ],
      "name": string Host name
      },
      "status": boolean
      }
      Codes:
      Code Message Description
      400 Domain zone not support Domain zone not support
      403 Authorization failed Invalid token
      403 The status of the order does not allow to perform the operation The status of the order does not allow to perform the operation
      403 Token not found Token not found
      404 Object not found {{ info }} Object not found
      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 }
  • Costomers

    Customers manage
    • Customer

      no implementation for this version
      Customer
      Presentation:
      {
      "address": string, Customer's address
      "city": string, Customer's city
      "company": string, Company
      "country": string, Two symbols country code
      "fax": string, Customer's fax number
      "lang": string, Two symbols language code
      "mail": string, Customer's E-mail
      "name": string, Customer's full name
      "password": string, Customer's password
      "phone": string, Customer's phone number
      "post_adress": string, Customer's post address
      "region": string, Customer's region
      "zip": integer Zip code
      }
      Formats:
      Sample:
      { "address": "Big Sea 23", "city": "Mykolaiv", "company": "Omnilance", "country": "UA", "fax": "380.631234567", "lang": "en", "mail": "customer@email.com", "name": "John Doe", "password": "1cdc@%)s$fd", "phone": "380.631234567", "post_adress": "Big Sea 23, 41", "region": "Mykolaivska", "zip": 54000 }
  • Contacts

    Contacts manage
    • Contact

      no implementation for this version
      Contact
      Presentation:
      {
      "address": string, Contact's address
      "city": string, Contact's city
      "company": string, Contact company
      "country": string, Contact's country
      "fax": string, Contact's fax number
      "mail": string, Contact's E-mail
      "name": string, Contact Name
      "phone": string, Contact's phone number
      "region": string, Contact's region
      "zip": string Zip code
      }
      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" }
  • Domains

    Domains manage
    • Domain

      no implementation for this version
      Domain
      Presentation:
      {
      "contact_admin": string, Domain admin contact ID
      "contact_billing": string, Domain billing contact ID
      "contact_registrant": string, Domain registrant contact ID
      "contact_tech": string, Domain tech contact ID
      "date_created": string, Domain order start date
      "date_end": string, Date of completion of the delegation
      "ns": [ An array with a list of NS servers for the domain
      string
      ],
      "status": string Order status: '0' - Request, '1' - In processing, '2' - Active, '3' - Overdue, '6' - Removal
      }
      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
      List of Domain Zones
      Presentation:
      {
      "date_end_reg_action": string, Date of completion of the promotion for registration
      "date_end_renew_action": string, Date of completion of the promotion for renewal
      "idn_avail": boolean, IDN support
      "max_length": integer, Maximum number of years for registration
      "min_length": integer, Minimum number of years to register
      "price_reg": number, Registration price
      "price_reg_action": number, Promotion price
      "price_renew": number, Renewal price
      "price_renew_action": number, Promotional renewal price
      "price_restore": number, Restore price
      "price_transfer": number, Transfer price
      "transfer_avail": boolean, Availability of transfer
      "zone": string Domain's zone name
      }
      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"