Tutorial: Purchase Custom Domain Name Using API

This tutorial introduces the request parameters and provides a request example to show you how to purchase Custom Domain Name using API.

Before you begin: Understand the request parameters

Before purchasing Custom Domain Name using API, we recommend that you read the table below to understand the request parameters and collect the corresponding values.

Item Parameter Description
Operation Type operationType The operation type.

In this scenario, the value is fixed at purchase_service.
Product ID productId Specify the product to which you want to subscribe.

The Product ID for Add-on Service is 19.
Partner ID partnerId Specify the user for whom you want to purchase Custom Domain Name.
Note: This parameter is required only when you purchase for a subordinate user. You will need to query the information as described in the following steps.
Billing Contact ID billingId Specify the contact who can receive the invoice after you purchase Custom Domain Name.

You will need to query the Billing Contact ID as described in the following steps.
Service Type serviceType The service type.

In this scenario, the value is fixed at service.
Service ID serviceId Specify the specific service to which you want to subscribe.

You will need to query the Service ID as described in the following steps.
Purchase Type purchaseType The purchase type.

In this scenario, the value is fixed at purchase.
Quantity quantity Specify the number of custom domain names to which you want to subscribe.
Billing Model billingModel

The billing model.

In this scenario, the value is fixed at recurring.
Billing Cycle billingCycle

The billing cycle.

In this scenario, the value is fixed at annually.
Multi Cycle multiCycle

The interval of recurring billing.

In this scenario, the value is fixed at 0.

(Optional) Step 1. Get subordinate user ID

  1. Make a request to the Query Subordinate User List API endpoint.
    GET {base_url}/user/openapi/user/v1/client/partner_list
  2. Note down the returned value of partnerId for the desired subordinate user.

Step 2. Get service ID

  1. Make a request to the Query Available Subscription / Trial Plans and Services for a Product API endpoint with the Product ID 19.
    GET {base_url}/pricing/openapi/purchase/v1/purchase_product_info?productId=19
  2. Note down the returned value of serviceId for Custom Domain Name.

Step 3. Get billing contact ID

  1. Make a request to the Query Billing Contact List API endpoint.
    GET {base_url}/user/openapi/user/v1/client/billing_contact_list
  2. Note down the returned value of billingContactId for the desired billing contact.

Step 4. Purchase Custom Domain Name

Make a request to the Create an Order API endpoint with the collected values.

POST {base_url}/order/openapi/order/v1/save

In this tutorial, the values we collect are shown below:

Item Parameter Value
Operation Type operationType purchase_service
Product ID productId 19
Billing Contact ID billingId 3197218168379846218
Service Type serviceType

service
Service ID serviceId 3181927247249457152
Purchase Type purchaseType purchase
Quantity quantity 2
Billing Model billingModel recurring
Billing Cycle billingCycle annually
Multi Cycle multiCycle 0

The sample request to purchase 2 custom domain names for one year is shown below:

POST /order/openapi/order/v1/save HTTP/1.1
Host: openapi.partner.yeastar.com
Content-Type: application/json
User-Agent: OpenAPI
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsicmVzMSJdLCJYLU1TLVVTRVIiOiJ7XCJleHByXCI6XCIwXCIsXCJ0eXBlXCI6XCJwYXJ0bmVyXCIsXCJ1Y0lkXCI6XCIzMDc2OTE1NDU0NDY4NzY3NzQ0XCIsXCJ1c2VyQ29kZVwiOlwiUGFydG5lclwiLFwidXNlcklkXCI6XCIzMDc2OTE1NDU0NDg5NzM5MjY0XCIsXCJ1c2VybmFtZVwiOlwicGFydG5lcmV4YW1wbGVAb3V0bG9vay5jb21cIn0iLCJ1c2VyX25hbWUiOiJwYXJ0bmVyZXhhbXBsZUBvdXRsb29rLmNvbSIsInNjb3BlIjpbImFsbCJdLCJleHAiOjE3Mzk3MTc5MjYsInRva2VuX3R5cGUiOiJvcGVuYXBpIiwianRpIjoidmlzMkh0QkxaUStNQmxPbS9UdThWR1pyNFljPSIsImF1dGhvcml0aWVzIjpbIjc5Il0sImNsaWVudF9pZCI6IjE0NDI5NjM2ODBiMjM0YjA0YmRjZDVjMTZmODcyOWQ2In0.RPRoTJRkXCB4krDSwGRpUFyCfUVv2LHjIiBICA1pCiY

{
  "operationType": "purchase_service",
  "productId": 19,
  "billingId": 3197218168379846218,
  "serviceList": [
    {
      "serviceType": "service",
      "serviceId": 3181927247249457152,
      "purchaseType": "purchase",
      "quantity": 2,
      "billingModel": "recurring",
      "billingCycle": "annually",
      "multiCycle": 0
    }
  ]
}

Result

The sample response is shown below:

{
    "code": "success",
    "detailMessage": "",
    "requestId": "adb3f41e6e889543e71e373329f926e0",
    "result": {
        "instanceId": "1944688",
        "orderId": "1779999",
        "orderNo": "UG3400799727332569088",
        "orderStatus": "succeed",
        "productNo": "3076913644890832896",
        "transactionNo": "VN3400799728066572289"
    },
    "status": 200
}