6 Customers API: How to create a customer handle

This is a series of articles dedicated to managing customer objects via Openprovider API.

This is a first article in a series in which we are going to cover customer handle creation. To get more information about our API in general, please use our documentation portal as your reference.

Customer handles are used throughout the whole system in all product modules (domains, SSL, licenses etc). Every customer created in our system gets a unique identifier or a customer "handle". These handles allow you to reuse recurring customers, meaning you will not have to fill in all the information every time you wish to register a domain name. Another benefit is that you can simply update the customer handle if they ever change their details, this will result in your domain names being updated as well.

Creating a handle

First, let's focus on adding that handle. While some domain registries require specific data to be provided within the handle object (more on this could be found in Customer Extension Additional Data section of the Openprovider docs) it is important that we have at least the bare minimum of information to be able to register domain names and order SSL certificates. All of the required fields are marked accordingly in the following table.

Entering Geo Fence iconUse endpoint path below. Base URL is determined by both the target environment and API version.
POST {base_url}/customers

REQUEST VALUES

Name Type Description
company_name string Optional. If customer is a company
vat string Optional.
name string Required.
address string Required.
phone various Required.
fax various Optional.
email various Required.
additional_data various Optional.
extension_additional_data various Required for some TLDs
locale predefined Optional.
tags varchar Optional.

REQUEST EXAMPLE

RESPONSE EXAMPLE

{
"code": 0,
"data": {
"handle": "XX123456-XX"
},
"desc": ""
}

RESPONSE VALUES

Name Type Description
handle varchar Customer unique identifier or handle

In the following article we'll get into retrieving information from an existing handle.

Was this article helpful?
0 out of 0 found this helpful
Additional questions? Submit a request