{
"info": {
"_postman_id": "8f1da5b0-1d64-4afb-8cb3-1545601ed9b8",
"name": "Camoo Hosting Reseller API",
"description": "Complete, interactive Postman Collection for the Camoo.Hosting Reseller API. Features automated JWT token persistence upon authentication, pre-populated form-data request bodies, and example response payloads.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"version": "1.0.0"
},
"variable": [
{
"key": "base_url",
"value": "https://api.camoo.hosting/v1",
"type": "string"
},
{
"key": "bearer_token",
"value": "",
"type": "string",
"description": "30-minute JWT bearer token obtained from POST /auth"
}
],
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{bearer_token}}",
"type": "string"
}
]
},
"item": [
{
"name": "Authentication",
"description": "Reseller account credentials and session access tokens.",
"item": [
{
"name": "Authenticate reseller and obtain access token",
"event": [
{
"listen": "test",
"script": {
"exec": [
"if (pm.response.code === 200) {",
" var data = pm.response.json();",
" var token = data.access_token || (data.result && data.result.access_token) || (data.result && data.result.token);",
" if (token) {",
" pm.collectionVariables.set(\"bearer_token\", token);",
" console.log(\"Saved bearer_token to collection variables\");",
" }",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "email",
"value": "you@example.com",
"type": "text",
"description": "Reseller account email address."
},
{
"key": "password",
"value": "secret123",
"type": "text",
"description": "Reseller account password."
}
]
},
"url": {
"raw": "{{base_url}}/auth",
"host": [
"{{base_url}}"
],
"path": [
"auth"
]
},
"description": "Exchange reseller account credentials for a 30-minute JWT bearer token. This endpoint does not require an Authorization header. Upon successful execution, the returned access_token is automatically saved to the collection variable `bearer_token`."
},
"response": [
{
"name": "200 Authentication Successful",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "email",
"value": "you@example.com",
"type": "text"
},
{
"key": "password",
"value": "secret123",
"type": "text"
}
]
},
"url": {
"raw": "{{base_url}}/auth",
"host": [
"{{base_url}}"
],
"path": [
"auth"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"message\": \"Authentication successful\",\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.example_token\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 1800\n}"
}
]
}
]
},
{
"name": "Confirms",
"description": "Email confirmation token verification for registry handles.",
"item": [
{
"name": "Confirm Antic domain",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/confirms/antic",
"host": [
"{{base_url}}"
],
"path": [
"confirms",
"antic"
]
},
"description": "Confirms an Antic domain using the validation hash.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "hash",
"value": "validation-hash",
"type": "text",
"description": "Validation hash received by email."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/confirms/antic",
"host": [
"{{base_url}}"
],
"path": [
"confirms",
"antic"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "hash",
"value": "validation-hash",
"type": "text",
"description": "Validation hash received by email."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"domain\": \"ok\"\n }\n}"
}
]
},
{
"name": "Confirm handle change",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/confirms/handle",
"host": [
"{{base_url}}"
],
"path": [
"confirms",
"handle"
]
},
"description": "Confirms a registrant handle change using the validation hash.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "hash",
"value": "validation-hash",
"type": "text",
"description": "Validation hash received by email."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/confirms/handle",
"host": [
"{{base_url}}"
],
"path": [
"confirms",
"handle"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "hash",
"value": "validation-hash",
"type": "text",
"description": "Validation hash received by email."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"handle_change\": \"ok\"\n }\n}"
}
]
}
]
},
{
"name": "Contacts",
"description": "Manage registrant, administrative, billing, and technical contacts.",
"item": [
{
"name": "Adding Contact",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/contacts/add",
"host": [
"{{base_url}}"
],
"path": [
"contacts",
"add"
]
},
"description": "Adds a Contact to the domain using the details provided.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "John Doe",
"type": "text",
"description": "Name of the Contact"
},
{
"key": "company",
"value": "Doe Ltd.",
"type": "text",
"description": "Name of the Company"
},
{
"key": "email",
"value": "new-contact@domain.cm",
"type": "text",
"description": "Email address of the Contact"
},
{
"key": "address-1",
"value": "Bastos",
"type": "text",
"description": "First line of address of the Contact"
},
{
"key": "city",
"value": "Yaounde",
"type": "text",
"description": "Name of the city"
},
{
"key": "ccode",
"value": "CM",
"type": "text",
"description": "Country code as per ISO 3166-1 alpha-2"
},
{
"key": "zipcode",
"value": "0000",
"type": "text",
"description": "Zip Code"
},
{
"key": "phone-cc",
"value": "237",
"type": "text",
"description": "Telephone number country code"
},
{
"key": "phone",
"value": "612345689",
"type": "text",
"description": "Telephone number"
},
{
"key": "state",
"value": "Centre",
"type": "text",
"description": "Name of the State"
},
{
"key": "address-2",
"value": "",
"type": "text",
"description": "second line of address of the Contact"
},
{
"key": "address-3",
"value": "",
"type": "text",
"description": "Third line of address of the Contact"
},
{
"key": "fax-cc",
"value": "",
"type": "text",
"description": "Fax number country code"
},
{
"key": "fax",
"value": "",
"type": "text",
"description": "Fax number"
},
{
"key": "customer-id",
"value": "",
"type": "text",
"description": "The Customer under whom you want to create the Contact"
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/contacts/add",
"host": [
"{{base_url}}"
],
"path": [
"contacts",
"add"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "John Doe",
"type": "text",
"description": "Name of the Contact"
},
{
"key": "company",
"value": "Doe Ltd.",
"type": "text",
"description": "Name of the Company"
},
{
"key": "email",
"value": "new-contact@domain.cm",
"type": "text",
"description": "Email address of the Contact"
},
{
"key": "address-1",
"value": "Bastos",
"type": "text",
"description": "First line of address of the Contact"
},
{
"key": "city",
"value": "Yaounde",
"type": "text",
"description": "Name of the city"
},
{
"key": "ccode",
"value": "CM",
"type": "text",
"description": "Country code as per ISO 3166-1 alpha-2"
},
{
"key": "zipcode",
"value": "0000",
"type": "text",
"description": "Zip Code"
},
{
"key": "phone-cc",
"value": "237",
"type": "text",
"description": "Telephone number country code"
},
{
"key": "phone",
"value": "612345689",
"type": "text",
"description": "Telephone number"
},
{
"key": "state",
"value": "Centre",
"type": "text",
"description": "Name of the State"
},
{
"key": "address-2",
"value": "",
"type": "text",
"description": "second line of address of the Contact"
},
{
"key": "address-3",
"value": "",
"type": "text",
"description": "Third line of address of the Contact"
},
{
"key": "fax-cc",
"value": "",
"type": "text",
"description": "Fax number country code"
},
{
"key": "fax",
"value": "",
"type": "text",
"description": "Fax number"
},
{
"key": "customer-id",
"value": "",
"type": "text",
"description": "The Customer under whom you want to create the Contact"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"id\": \"2334\"\n }\n}"
}
]
},
{
"name": "Modify Contact",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/contacts/edit",
"host": [
"{{base_url}}"
],
"path": [
"contacts",
"edit"
]
},
"description": "Modifies the details of an existing Contact.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "2334",
"type": "text",
"description": "Contact / Identity ID to modify"
},
{
"key": "name",
"value": "John Doe Updated",
"type": "text",
"description": "Name of the Contact"
},
{
"key": "company",
"value": "Doe Ltd.",
"type": "text",
"description": "Name of the Company"
},
{
"key": "email",
"value": "contact@domain.cm",
"type": "text",
"description": "Email address of the Contact"
},
{
"key": "address-1",
"value": "Bastos",
"type": "text",
"description": "First line of address of the Contact"
},
{
"key": "city",
"value": "Yaounde",
"type": "text",
"description": "Name of the city"
},
{
"key": "ccode",
"value": "CM",
"type": "text",
"description": "Country code as per ISO 3166-1 alpha-2"
},
{
"key": "zipcode",
"value": "0000",
"type": "text",
"description": "Zip Code"
},
{
"key": "phone-cc",
"value": "237",
"type": "text",
"description": "Telephone number country code"
},
{
"key": "phone",
"value": "612345689",
"type": "text",
"description": "Telephone number"
},
{
"key": "state",
"value": "Centre",
"type": "text",
"description": "Name of the State"
},
{
"key": "address-2",
"value": "",
"type": "text",
"description": "Second line of address of the Contact"
},
{
"key": "address-3",
"value": "",
"type": "text",
"description": "Third line of address of the Contact"
},
{
"key": "fax-cc",
"value": "",
"type": "text",
"description": "Fax number country code"
},
{
"key": "fax",
"value": "",
"type": "text",
"description": "Fax number"
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/contacts/edit",
"host": [
"{{base_url}}"
],
"path": [
"contacts",
"edit"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "2334",
"type": "text",
"description": "Contact / Identity ID to modify"
},
{
"key": "name",
"value": "John Doe Updated",
"type": "text",
"description": "Name of the Contact"
},
{
"key": "company",
"value": "Doe Ltd.",
"type": "text",
"description": "Name of the Company"
},
{
"key": "email",
"value": "contact@domain.cm",
"type": "text",
"description": "Email address of the Contact"
},
{
"key": "address-1",
"value": "Bastos",
"type": "text",
"description": "First line of address of the Contact"
},
{
"key": "city",
"value": "Yaounde",
"type": "text",
"description": "Name of the city"
},
{
"key": "ccode",
"value": "CM",
"type": "text",
"description": "Country code as per ISO 3166-1 alpha-2"
},
{
"key": "zipcode",
"value": "0000",
"type": "text",
"description": "Zip Code"
},
{
"key": "phone-cc",
"value": "237",
"type": "text",
"description": "Telephone number country code"
},
{
"key": "phone",
"value": "612345689",
"type": "text",
"description": "Telephone number"
},
{
"key": "state",
"value": "Centre",
"type": "text",
"description": "Name of the State"
},
{
"key": "address-2",
"value": "",
"type": "text",
"description": "Second line of address of the Contact"
},
{
"key": "address-3",
"value": "",
"type": "text",
"description": "Third line of address of the Contact"
},
{
"key": "fax-cc",
"value": "",
"type": "text",
"description": "Fax number country code"
},
{
"key": "fax",
"value": "",
"type": "text",
"description": "Fax number"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"id\": 2334,\n \"message\": \"Contact modified successfully\"\n }\n}"
}
]
}
]
},
{
"name": "Customers",
"description": "Reseller customer account management and SSO login.",
"item": [
{
"name": "Adding Customer",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/customers/add",
"host": [
"{{base_url}}"
],
"path": [
"customers",
"add"
]
},
"description": "Creates a Customer Account using the details provided.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "John Doe",
"type": "text",
"description": "Name of the Customer"
},
{
"key": "company",
"value": "Doe Ltd.",
"type": "text",
"description": "Name of the Company"
},
{
"key": "email",
"value": "new-contact@domain.cm",
"type": "text",
"description": "Email address of the Customer"
},
{
"key": "address-1",
"value": "Bastos",
"type": "text",
"description": "First line of address of the Customer"
},
{
"key": "city",
"value": "Yaounde",
"type": "text",
"description": "Name of the city"
},
{
"key": "ccode",
"value": "CM",
"type": "text",
"description": "Country code as per ISO 3166-1 alpha-2"
},
{
"key": "zipcode",
"value": "0000",
"type": "text",
"description": "Zip Code"
},
{
"key": "phone-cc",
"value": "237",
"type": "text",
"description": "Telephone number country code"
},
{
"key": "phone",
"value": "612345689",
"type": "text",
"description": "Telephone number"
},
{
"key": "lang-pref",
"value": "fr_FR",
"type": "text",
"description": "Language Code as per ISO"
},
{
"key": "state",
"value": "Centre",
"type": "text",
"description": "Name of the State"
},
{
"key": "address-2",
"value": "",
"type": "text",
"description": "second line of address of the Customer"
},
{
"key": "address-3",
"value": "",
"type": "text",
"description": "Third line of address of the Customer"
},
{
"key": "fax-cc",
"value": "",
"type": "text",
"description": "Fax number country code"
},
{
"key": "fax",
"value": "",
"type": "text",
"description": "Fax number"
},
{
"key": "terms",
"value": "1",
"type": "text",
"description": "Accept Terms and Conditions and Privacy Policy to create an account"
},
{
"key": "password",
"value": "TopSecre!Passwd",
"type": "text",
"description": "Sets login Password for the customer"
},
{
"key": "password_confirm",
"value": "TopSecre!Passwd",
"type": "text",
"description": "Required if Password is set. It should be the same value as Password"
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/customers/add",
"host": [
"{{base_url}}"
],
"path": [
"customers",
"add"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "John Doe",
"type": "text",
"description": "Name of the Customer"
},
{
"key": "company",
"value": "Doe Ltd.",
"type": "text",
"description": "Name of the Company"
},
{
"key": "email",
"value": "new-contact@domain.cm",
"type": "text",
"description": "Email address of the Customer"
},
{
"key": "address-1",
"value": "Bastos",
"type": "text",
"description": "First line of address of the Customer"
},
{
"key": "city",
"value": "Yaounde",
"type": "text",
"description": "Name of the city"
},
{
"key": "ccode",
"value": "CM",
"type": "text",
"description": "Country code as per ISO 3166-1 alpha-2"
},
{
"key": "zipcode",
"value": "0000",
"type": "text",
"description": "Zip Code"
},
{
"key": "phone-cc",
"value": "237",
"type": "text",
"description": "Telephone number country code"
},
{
"key": "phone",
"value": "612345689",
"type": "text",
"description": "Telephone number"
},
{
"key": "lang-pref",
"value": "fr_FR",
"type": "text",
"description": "Language Code as per ISO"
},
{
"key": "state",
"value": "Centre",
"type": "text",
"description": "Name of the State"
},
{
"key": "address-2",
"value": "",
"type": "text",
"description": "second line of address of the Customer"
},
{
"key": "address-3",
"value": "",
"type": "text",
"description": "Third line of address of the Customer"
},
{
"key": "fax-cc",
"value": "",
"type": "text",
"description": "Fax number country code"
},
{
"key": "fax",
"value": "",
"type": "text",
"description": "Fax number"
},
{
"key": "terms",
"value": "1",
"type": "text",
"description": "Accept Terms and Conditions and Privacy Policy to create an account"
},
{
"key": "password",
"value": "TopSecre!Passwd",
"type": "text",
"description": "Sets login Password for the customer"
},
{
"key": "password_confirm",
"value": "TopSecre!Passwd",
"type": "text",
"description": "Required if Password is set. It should be the same value as Password"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"id\": \"123\"\n }\n}"
}
]
},
{
"name": "Modify Customer",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/customers/edit",
"host": [
"{{base_url}}"
],
"path": [
"customers",
"edit"
]
},
"description": "Modifies the details of an existing Reseller Customer.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "123",
"type": "text",
"description": "Customer ID to modify"
},
{
"key": "name",
"value": "John Doe Updated",
"type": "text",
"description": "Name of the Customer"
},
{
"key": "company",
"value": "Doe Ltd.",
"type": "text",
"description": "Name of the Company"
},
{
"key": "email",
"value": "new-contact@domain.cm",
"type": "text",
"description": "Email address of the Customer"
},
{
"key": "lang-pref",
"value": "fr_FR",
"type": "text",
"description": "Language Preference (fr_FR or en_GB)"
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/customers/edit",
"host": [
"{{base_url}}"
],
"path": [
"customers",
"edit"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "123",
"type": "text",
"description": "Customer ID to modify"
},
{
"key": "name",
"value": "John Doe Updated",
"type": "text",
"description": "Name of the Customer"
},
{
"key": "company",
"value": "Doe Ltd.",
"type": "text",
"description": "Name of the Company"
},
{
"key": "email",
"value": "new-contact@domain.cm",
"type": "text",
"description": "Email address of the Customer"
},
{
"key": "lang-pref",
"value": "fr_FR",
"type": "text",
"description": "Language Preference (fr_FR or en_GB)"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"id\": 123,\n \"message\": \"Customer modified successfully\"\n }\n}"
}
]
},
{
"name": "Get Customer By Id",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/customers/get-by-id?id=",
"host": [
"{{base_url}}"
],
"path": [
"customers",
"get-by-id"
],
"query": [
{
"key": "id",
"value": "",
"description": "Customer's ID"
}
]
},
"description": "Gets Reseller Customer By Id."
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/customers/get-by-id?id=",
"host": [
"{{base_url}}"
],
"path": [
"customers",
"get-by-id"
],
"query": [
{
"key": "id",
"value": "",
"description": "Customer's ID"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"id\": 123,\n \"username\": \"new-contact@domain.cm\",\n \"identities\": [\n {\n \"id\": 1960,\n \"email\": \"new-contact@domain.cm\",\n \"name\": \"John Doe\",\n \"company\": \"Doe Ltd.\",\n \"...\": \"...\"\n }\n ]\n }\n}"
}
]
},
{
"name": "Get Customer By E-mail",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/customers/get-by-email?email=",
"host": [
"{{base_url}}"
],
"path": [
"customers",
"get-by-email"
],
"query": [
{
"key": "email",
"value": "",
"description": "Customer's Email"
}
]
},
"description": "Gets Reseller Customer By Email."
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/customers/get-by-email?email=",
"host": [
"{{base_url}}"
],
"path": [
"customers",
"get-by-email"
],
"query": [
{
"key": "email",
"value": "",
"description": "Customer's Email"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"id\": 123,\n \"username\": \"new-contact@domain.cm\",\n \"identities\": [\n {\n \"id\": 1960,\n \"email\": \"new-contact@domain.cm\",\n \"name\": \"John Doe\",\n \"company\": \"Doe Ltd.\",\n \"...\": \"...\"\n }\n ]\n }\n}"
}
]
},
{
"name": "Get SSO Token By Id",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/customers/sso?id=",
"host": [
"{{base_url}}"
],
"path": [
"customers",
"sso"
],
"query": [
{
"key": "id",
"value": "",
"description": "Customer's ID"
}
]
},
"description": "Gets Reseller Customer SSO Token By Id."
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/customers/sso?id=",
"host": [
"{{base_url}}"
],
"path": [
"customers",
"sso"
],
"query": [
{
"key": "id",
"value": "",
"description": "Customer's ID"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"sso_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9\"\n }\n}"
}
]
},
{
"name": "Customer Authentication",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/customers/auth",
"host": [
"{{base_url}}"
],
"path": [
"customers",
"auth"
]
},
"description": "Authenticates a reseller customer with email and password.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "email",
"value": "customer@example.cm",
"type": "text",
"description": "Customer account email"
},
{
"key": "password",
"value": "CustomerPasswd!2026",
"type": "text",
"description": "Customer login password"
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/customers/auth",
"host": [
"{{base_url}}"
],
"path": [
"customers",
"auth"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "email",
"value": "customer@example.cm",
"type": "text",
"description": "Customer account email"
},
{
"key": "password",
"value": "CustomerPasswd!2026",
"type": "text",
"description": "Customer login password"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"id\": 123,\n \"username\": \"customer@example.cm\",\n \"identities\": [\n {\n \"id\": 1960,\n \"email\": \"customer@example.cm\",\n \"name\": \"John Doe\"\n }\n ]\n }\n}"
}
]
},
{
"name": "Get Customer Balance",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/customers/balance?id=¤cy=",
"host": [
"{{base_url}}"
],
"path": [
"customers",
"balance"
],
"query": [
{
"key": "id",
"value": "",
"description": "Reseller customer identifier."
},
{
"key": "currency",
"value": "",
"description": "Currency code for the balance (default: XAF)."
}
]
},
"description": "Gets the account balance and unpaid invoice totals for a specific reseller customer."
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/customers/balance?id=¤cy=",
"host": [
"{{base_url}}"
],
"path": [
"customers",
"balance"
],
"query": [
{
"key": "id",
"value": "",
"description": "Reseller customer identifier."
},
{
"key": "currency",
"value": "",
"description": "Currency code for the balance (default: XAF)."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"customer_id\": 123,\n \"username\": \"customer@example.cm\",\n \"balance\": 15000,\n \"currency\": \"XAF\",\n \"unpaid_amount\": 0\n }\n}"
}
]
}
]
},
{
"name": "DNS",
"description": "DNS zone activation and custom resource record management.",
"item": [
{
"name": "Activate",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/dns/activate",
"host": [
"{{base_url}}"
],
"path": [
"dns",
"activate"
]
},
"description": "Activates the DNS service for a domain.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "1234",
"type": "text",
"description": "Domain ID that you need to activate our DNS service."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/dns/activate",
"host": [
"{{base_url}}"
],
"path": [
"dns",
"activate"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "1234",
"type": "text",
"description": "Domain ID that you need to activate our DNS service."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"zone_id\": 123,\n \"message\": \"DNS service activated successfully\"\n }\n}"
}
]
},
{
"name": "Add Record",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/dns/add-record",
"host": [
"{{base_url}}"
],
"path": [
"dns",
"add-record"
]
},
"description": "Adds a DNS record to an active DNS zone.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "zone_id",
"value": "1234",
"type": "text",
"description": "Zone ID for which you want to add the record"
},
{
"key": "value",
"value": "example.cm",
"type": "text",
"description": "A Fully Qualified Domain Name (FQDN) as the destination"
},
{
"key": "type",
"value": "cname",
"type": "text",
"description": "Type of record you want to add"
},
{
"key": "host",
"value": "www",
"type": "text",
"description": "The host part of the domain name for which you need to add a record"
},
{
"key": "ttl",
"value": "",
"type": "text",
"description": "Number of seconds the record needs to be cached by the DNS Resolvers. Default value is 14400."
},
{
"key": "priority",
"value": "",
"type": "text",
"description": "The Priority of the host/record. Value ranges from 0 to 65535."
},
{
"key": "port",
"value": "",
"type": "text",
"description": "The port number of the service"
},
{
"key": "weight",
"value": "",
"type": "text",
"description": "A relative weight for records with the same priority"
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/dns/add-record",
"host": [
"{{base_url}}"
],
"path": [
"dns",
"add-record"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "zone_id",
"value": "1234",
"type": "text",
"description": "Zone ID for which you want to add the record"
},
{
"key": "value",
"value": "example.cm",
"type": "text",
"description": "A Fully Qualified Domain Name (FQDN) as the destination"
},
{
"key": "type",
"value": "cname",
"type": "text",
"description": "Type of record you want to add"
},
{
"key": "host",
"value": "www",
"type": "text",
"description": "The host part of the domain name for which you need to add a record"
},
{
"key": "ttl",
"value": "",
"type": "text",
"description": "Number of seconds the record needs to be cached by the DNS Resolvers. Default value is 14400."
},
{
"key": "priority",
"value": "",
"type": "text",
"description": "The Priority of the host/record. Value ranges from 0 to 65535."
},
{
"key": "port",
"value": "",
"type": "text",
"description": "The port number of the service"
},
{
"key": "weight",
"value": "",
"type": "text",
"description": "A relative weight for records with the same priority"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"record_id\": 123,\n \"message\": \"DNS record created successfully\"\n }\n}"
}
]
},
{
"name": "Delete Record",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/dns/delete-record",
"host": [
"{{base_url}}"
],
"path": [
"dns",
"delete-record"
]
},
"description": "Deletes a DNS record from a zone.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "zone_id",
"value": "123",
"type": "text",
"description": "Zone ID under which the record exists"
},
{
"key": "record_id",
"value": "144",
"type": "text",
"description": "Record ID that you want to delete."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/dns/delete-record",
"host": [
"{{base_url}}"
],
"path": [
"dns",
"delete-record"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "zone_id",
"value": "123",
"type": "text",
"description": "Zone ID under which the record exists"
},
{
"key": "record_id",
"value": "144",
"type": "text",
"description": "Record ID that you want to delete."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"zone_id\": 123,\n \"message\": \"DNS record deleted successfully\"\n }\n}"
}
]
}
]
},
{
"name": "Domains",
"description": "Domain search, registration, renewals, transfers, and security.",
"item": [
{
"name": "Check availability",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/availability",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"availability"
]
},
"description": "Checks the availability of the specified domain name(s).",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "domain",
"value": "example",
"type": "text",
"description": "Domain name that you need to check the availability for. Without extension e.g: google"
},
{
"key": "tlds",
"value": "cm,net.cm",
"type": "text",
"description": "TLDs for which the domain name availability needs to be checked. For more than one, it should be separated with commas"
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/availability",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"availability"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "domain",
"value": "example",
"type": "text",
"description": "Domain name that you need to check the availability for. Without extension e.g: google"
},
{
"key": "tlds",
"value": "cm,net.cm",
"type": "text",
"description": "TLDs for which the domain name availability needs to be checked. For more than one, it should be separated with commas"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"example.cm\": {\n \"classkey\": \"anticcm\",\n \"status\": \"N\",\n \"antic\": true,\n \"promo\": [],\n \"price\": {\n \"addtransferdomain\": \"7000\",\n \"restoredomain\": \"7000\",\n \"addnewdomain\": \"7000\",\n \"renewdomain\": \"7000\"\n },\n \"currency\": \"XAF\"\n },\n \"example.net.cm\": {\n \"classkey\": \"anticnetcm\",\n \"status\": \"Y\",\n \"antic\": true,\n \"promo\": [],\n \"price\": {\n \"addtransferdomain\": \"7000\",\n \"restoredomain\": \"7000\",\n \"addnewdomain\": \"7000\",\n \"renewdomain\": \"7000\"\n },\n \"currency\": \"XAF\"\n }\n }\n}"
}
]
},
{
"name": "Register",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/register",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"register"
]
},
"description": "Registers a domain name.\n\n**Note**: A valid contact must be created first before registering a domain name.;Use POST /contacts/add to create registrant, administrative, technical, and billing contacts.;Provide the returned contact IDs for reg-contact-id, admin-contact-id, tech-contact-id, and billing-contact-id.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "domain-name",
"value": "example.cm",
"type": "text",
"description": "Domain name that you need to Register. e.g: example.cm"
},
{
"key": "years",
"value": "1",
"type": "text",
"description": "Number of years for which you wish to Register this domain name."
},
{
"key": "ns",
"value": "ns1.yourCompany.cm,ns2.yourCompany.cm",
"type": "text",
"description": "The Name Servers of the domain name."
},
{
"key": "reg-contact-id",
"value": "1112",
"type": "text",
"description": "The Registrant Contact ID of the domain name (must be created first via POST /contacts/add)."
},
{
"key": "admin-contact-id",
"value": "1223",
"type": "text",
"description": "The Administrative Contact ID of the domain name (must be created first via POST /contacts/add)."
},
{
"key": "tech-contact-id",
"value": "1223",
"type": "text",
"description": "The Technical Contact ID of the domain name (must be created first via POST /contacts/add)."
},
{
"key": "billing-contact-id",
"value": "1223",
"type": "text",
"description": "The Billing Contact ID of the domain name (must be created first via POST /contacts/add)."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/register",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"register"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "domain-name",
"value": "example.cm",
"type": "text",
"description": "Domain name that you need to Register. e.g: example.cm"
},
{
"key": "years",
"value": "1",
"type": "text",
"description": "Number of years for which you wish to Register this domain name."
},
{
"key": "ns",
"value": "ns1.yourCompany.cm,ns2.yourCompany.cm",
"type": "text",
"description": "The Name Servers of the domain name."
},
{
"key": "reg-contact-id",
"value": "1112",
"type": "text",
"description": "The Registrant Contact ID of the domain name (must be created first via POST /contacts/add)."
},
{
"key": "admin-contact-id",
"value": "1223",
"type": "text",
"description": "The Administrative Contact ID of the domain name (must be created first via POST /contacts/add)."
},
{
"key": "tech-contact-id",
"value": "1223",
"type": "text",
"description": "The Technical Contact ID of the domain name (must be created first via POST /contacts/add)."
},
{
"key": "billing-contact-id",
"value": "1223",
"type": "text",
"description": "The Billing Contact ID of the domain name (must be created first via POST /contacts/add)."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"id\": \"38948498404\",\n \"domain\": \"example.cm\",\n \"message\": \"Domain registration completed Successfully\"\n }\n}"
}
]
},
{
"name": "Renew",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/renew",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"renew"
]
},
"description": "Renews the specified Domain Registration Order for specified number of years.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "38948498404",
"type": "text",
"description": "Domain Id of the Domain Registration Order that you want to Renew."
},
{
"key": "years",
"value": "1",
"type": "text",
"description": "Number of years for which you want to Renew this Order."
},
{
"key": "endtime",
"value": "1562912181",
"type": "text",
"description": "Current Expiry Date of the Order in epoch time format."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/renew",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"renew"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "38948498404",
"type": "text",
"description": "Domain Id of the Domain Registration Order that you want to Renew."
},
{
"key": "years",
"value": "1",
"type": "text",
"description": "Number of years for which you want to Renew this Order."
},
{
"key": "endtime",
"value": "1562912181",
"type": "text",
"description": "Current Expiry Date of the Order in epoch time format."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"domain\": \"example.cm\",\n \"message\": \"Domain renew completed Successfully\"\n }\n}"
}
]
},
{
"name": "Suspend",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/suspend",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"suspend"
]
},
"description": "Applies the Suspension on the specified Domain. Type of request POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "1234",
"type": "text",
"description": "domain ID for suspension"
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/suspend",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"suspend"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "1234",
"type": "text",
"description": "domain ID for suspension"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"domain\": \"example.cm\",\n \"message\": \"Domain suspension completed Successfully\"\n }\n}"
}
]
},
{
"name": "Unsuspend",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/unsuspend",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"unsuspend"
]
},
"description": "Removes the Suspension on the specified Domain. Type of request POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "1234",
"type": "text",
"description": "domain ID"
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/unsuspend",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"unsuspend"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "1234",
"type": "text",
"description": "domain ID"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"domain\": \"example.cm\",\n \"message\": \"Domain unsuspended Successfully\"\n }\n}"
}
]
},
{
"name": "Is Transferable",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/validate-transfer",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"validate-transfer"
]
},
"description": "Validating a Transfer Request",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "domain-name",
"value": "example.cm",
"type": "text",
"description": "domain name you want to check."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/validate-transfer",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"validate-transfer"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "domain-name",
"value": "example.cm",
"type": "text",
"description": "domain name you want to check."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": true\n}"
}
]
},
{
"name": "Transfer",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/transfer",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"transfer"
]
},
"description": "Transfers a domain name.\n\n**Note**: You need to ensure that the domain name is not Locked.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "domain-name",
"value": "example.cm",
"type": "text",
"description": "Domain name that you need to transfer. e.g: example.cm"
},
{
"key": "auth-code",
"value": "AKdo?dh-Ogh4",
"type": "text",
"description": "Authorization Code (EEP-code,Domain Secret, Auth Code) of the domain name that you want to transfer."
},
{
"key": "years",
"value": "1",
"type": "text",
"description": "Number of years for which you wish to transfer this domain name."
},
{
"key": "ns",
"value": "ns1.yourCompany.com,ns2.yourCompany.com",
"type": "text",
"description": "The Name Servers of the domain name."
},
{
"key": "reg-contact-id",
"value": "1112",
"type": "text",
"description": "The Registrant Contact of the domain name."
},
{
"key": "admin-contact-id",
"value": "1223",
"type": "text",
"description": "The Administrative Contact of the domain name."
},
{
"key": "tech-contact-id",
"value": "1223",
"type": "text",
"description": "The Technical Contact of the domain name."
},
{
"key": "billing-contact-id",
"value": "1223",
"type": "text",
"description": "The Billing Contact of the domain name."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/transfer",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"transfer"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "domain-name",
"value": "example.cm",
"type": "text",
"description": "Domain name that you need to transfer. e.g: example.cm"
},
{
"key": "auth-code",
"value": "AKdo?dh-Ogh4",
"type": "text",
"description": "Authorization Code (EEP-code,Domain Secret, Auth Code) of the domain name that you want to transfer."
},
{
"key": "years",
"value": "1",
"type": "text",
"description": "Number of years for which you wish to transfer this domain name."
},
{
"key": "ns",
"value": "ns1.yourCompany.com,ns2.yourCompany.com",
"type": "text",
"description": "The Name Servers of the domain name."
},
{
"key": "reg-contact-id",
"value": "1112",
"type": "text",
"description": "The Registrant Contact of the domain name."
},
{
"key": "admin-contact-id",
"value": "1223",
"type": "text",
"description": "The Administrative Contact of the domain name."
},
{
"key": "tech-contact-id",
"value": "1223",
"type": "text",
"description": "The Technical Contact of the domain name."
},
{
"key": "billing-contact-id",
"value": "1223",
"type": "text",
"description": "The Billing Contact of the domain name."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"id\": \"38948498406\",\n \"domain\": \"example.cm\",\n \"message\": \"Domain transfer queued Successfully\"\n }\n}"
}
]
},
{
"name": "Whois CM",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/cm-whois",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"cm-whois"
]
},
"description": "Makes a whois for .CM domains. Find out registrant information",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "domain-name",
"value": "example.cm",
"type": "text",
"description": "domain name you want to check."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/cm-whois",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"cm-whois"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "domain-name",
"value": "example.cm",
"type": "text",
"description": "domain name you want to check."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": \"TERMS OF USE ...\"\n}"
}
]
},
{
"name": "Get Domain details",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/details?id=",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"details"
],
"query": [
{
"key": "id",
"value": "",
"description": "Domain's ID"
}
]
},
"description": "Gets domain details By Id."
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/details?id=",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"details"
],
"query": [
{
"key": "id",
"value": "",
"description": "Domain's ID"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"id\": 123,\n \"domain-name\": \"yourDomain.cm\",\n \"years\": 1,\n \"created_at\": \"2016-05-03T17:46:23+01:00\"\n }\n}"
}
]
},
{
"name": "Modifying Name Servers",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/modify-nameservers",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"modify-nameservers"
]
},
"description": "Modifies the nameservers associated with a specific domain registration order.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "123",
"type": "text",
"description": "Identifier of the Domain Registration Order for which nameservers are to be modified."
},
{
"key": "ns",
"value": "ns1.yourCompany.com,ns2.yourCompany.com",
"type": "text",
"description": "Comma-separated list of new nameservers for the domain. Requires at least two nameservers."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/modify-nameservers",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"modify-nameservers"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "123",
"type": "text",
"description": "Identifier of the Domain Registration Order for which nameservers are to be modified."
},
{
"key": "ns",
"value": "ns1.yourCompany.com,ns2.yourCompany.com",
"type": "text",
"description": "Comma-separated list of new nameservers for the domain. Requires at least two nameservers."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"message\": \"Nameservers for Domain ID123 have been successfully modified.\"\n }\n}"
}
]
},
{
"name": "Enabling the Theft Protection Lock",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/theft-protection/enable",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"theft-protection",
"enable"
]
},
"description": "Applies the Theft Protection Lock on the specified domain registration order.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "123",
"type": "text",
"description": "Identifier of the Domain Registration Order for which theft protection is to be modified."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/theft-protection/enable",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"theft-protection",
"enable"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "123",
"type": "text",
"description": "Identifier of the Domain Registration Order for which theft protection is to be modified."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"message\": \"Theft protection for Domain ID123 has been successfully enabled.\"\n }\n}"
}
]
},
{
"name": "Disabling the Theft Protection Lock",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/theft-protection/disable",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"theft-protection",
"disable"
]
},
"description": "Disables the Theft Protection Lock on the specified domain registration order.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "123",
"type": "text",
"description": "Identifier of the Domain Registration Order on which the Theft Protection Lock is to be removed."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/theft-protection/disable",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"theft-protection",
"disable"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "123",
"type": "text",
"description": "Identifier of the Domain Registration Order on which the Theft Protection Lock is to be removed."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"message\": \"Theft protection for Domain ID123 has been successfully disabled.\"\n }\n}"
}
]
},
{
"name": "Enabling Whois Privacy",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/whois-privacy/enable",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"whois-privacy",
"enable"
]
},
"description": "Enables the Whois Privacy Protection on the specified domain registration order.\n\n**Note**: This service is not free.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "123",
"type": "text",
"description": "Identifier of the Domain Registration Order for which Whois privacy protection is to be enabled."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/whois-privacy/enable",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"whois-privacy",
"enable"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "123",
"type": "text",
"description": "Identifier of the Domain Registration Order for which Whois privacy protection is to be enabled."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"message\": \"Whois privacy protection for Domain ID123 has been successfully enabled.\"\n }\n}"
}
]
},
{
"name": "Disabling Whois Privacy",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/whois-privacy/disable",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"whois-privacy",
"disable"
]
},
"description": "Disables the Whois Privacy Protection on the specified domain registration order.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "123",
"type": "text",
"description": "Identifier of the Domain Registration Order for which Whois privacy protection is to be disabled."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/whois-privacy/disable",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"whois-privacy",
"disable"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "123",
"type": "text",
"description": "Identifier of the Domain Registration Order for which Whois privacy protection is to be disabled."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"message\": \"Whois privacy protection for Domain ID123 has been successfully disabled.\"\n }\n}"
}
]
},
{
"name": "Resend Verification Email",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/resend-verification-mail",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"resend-verification-mail"
]
},
"description": "Resends the registrant verification email for the specified domain.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "123",
"type": "text",
"description": "Identifier of the domain for which verification email is to be resent."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/domains/resend-verification-mail",
"host": [
"{{base_url}}"
],
"path": [
"domains",
"resend-verification-mail"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "123",
"type": "text",
"description": "Identifier of the domain for which verification email is to be resent."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"message\": \"Verification email resent successfully.\",\n \"success\": true\n }\n}"
}
]
}
]
},
{
"name": "Orders",
"description": "Online and offline checkout order creation.",
"item": [
{
"name": "Create offline order",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/order/offline",
"host": [
"{{base_url}}"
],
"path": [
"order",
"offline"
]
},
"description": "Creates an order to be settled offline.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "body",
"value": "{\"user\":1234,\"items\":[]}",
"type": "text",
"description": "JSON-encoded cart containing at least the reseller customer identifier in the user field."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/order/offline",
"host": [
"{{base_url}}"
],
"path": [
"order",
"offline"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "body",
"value": "{\"user\":1234,\"items\":[]}",
"type": "text",
"description": "JSON-encoded cart containing at least the reseller customer identifier in the user field."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"success\": true\n }\n}"
}
]
},
{
"name": "Create online order",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/order/online",
"host": [
"{{base_url}}"
],
"path": [
"order",
"online"
]
},
"description": "Creates an order after a completed online payment.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "body",
"value": "{\"user\":1234,\"payment_id\":\"payment-reference\",\"items\":[]}",
"type": "text",
"description": "JSON-encoded cart containing user and payment_id fields."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/order/online",
"host": [
"{{base_url}}"
],
"path": [
"order",
"online"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "body",
"value": "{\"user\":1234,\"payment_id\":\"payment-reference\",\"items\":[]}",
"type": "text",
"description": "JSON-encoded cart containing user and payment_id fields."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"success\": true\n }\n}"
}
]
}
]
},
{
"name": "Payments",
"description": "Mobile money and online payment settlement verification.",
"item": [
{
"name": "Mobile money payment",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/payment/mobile-money",
"host": [
"{{base_url}}"
],
"path": [
"payment",
"mobile-money"
]
},
"description": "Starts a mobile money payment for a reseller customer.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "phoneNumber",
"value": "+237600000000",
"type": "text",
"description": "Customer mobile number in international format."
},
{
"key": "amount",
"value": "5000",
"type": "text",
"description": "Amount to charge in the account currency."
},
{
"key": "customer",
"value": "1234",
"type": "text",
"description": "Reseller customer identifier."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/payment/mobile-money",
"host": [
"{{base_url}}"
],
"path": [
"payment",
"mobile-money"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "phoneNumber",
"value": "+237600000000",
"type": "text",
"description": "Customer mobile number in international format."
},
{
"key": "amount",
"value": "5000",
"type": "text",
"description": "Amount to charge in the account currency."
},
{
"key": "customer",
"value": "1234",
"type": "text",
"description": "Reseller customer identifier."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"paymentId\": \"payment-reference\",\n \"time\": 1700000000,\n \"message\": \"in progress\",\n \"success\": true\n }\n}"
}
]
},
{
"name": "Check mobile money payment",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/payment/check?payment_id=",
"host": [
"{{base_url}}"
],
"path": [
"payment",
"check"
],
"query": [
{
"key": "payment_id",
"value": "",
"description": "Payment reference returned by the payment request."
}
]
},
"description": "Checks whether a mobile money payment has been completed."
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/payment/check?payment_id=",
"host": [
"{{base_url}}"
],
"path": [
"payment",
"check"
],
"query": [
{
"key": "payment_id",
"value": "",
"description": "Payment reference returned by the payment request."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"success\": true\n }\n}"
}
]
}
]
},
{
"name": "Subdomains",
"description": "Sub-domain DNS record provisioning and deletion.",
"item": [
{
"name": "Adding Sub-domain",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/sub-domains/add",
"host": [
"{{base_url}}"
],
"path": [
"sub-domains",
"add"
]
},
"description": "Adds a subdomain to a domain using the details provided.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "dev",
"type": "text",
"description": "Hostname label for the subdomain."
},
{
"key": "domain-name",
"value": "example.cm",
"type": "text",
"description": "Parent domain under which the subdomain will be created."
},
{
"key": "target",
"value": "dev-folder",
"type": "text",
"description": "The target folder on the web space. If given target does not exist, the folder is created."
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/sub-domains/add",
"host": [
"{{base_url}}"
],
"path": [
"sub-domains",
"add"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "dev",
"type": "text",
"description": "Hostname label for the subdomain."
},
{
"key": "domain-name",
"value": "example.cm",
"type": "text",
"description": "Parent domain under which the subdomain will be created."
},
{
"key": "target",
"value": "dev-folder",
"type": "text",
"description": "The target folder on the web space. If given target does not exist, the folder is created."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"id\": \"1234\",\n \"message\": \"Subdomain created successfully\"\n }\n}"
}
]
},
{
"name": "Delete Sub-domain",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/sub-domains/delete",
"host": [
"{{base_url}}"
],
"path": [
"sub-domains",
"delete"
]
},
"description": "Deletes a subdomain using its identifier.",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "1234",
"type": "text",
"description": "Sub domain ID"
}
]
}
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/sub-domains/delete",
"host": [
"{{base_url}}"
],
"path": [
"sub-domains",
"delete"
]
},
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "1234",
"type": "text",
"description": "Sub domain ID"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": {\n \"message\": \"Subdomain deleted successfully\"\n }\n}"
}
]
}
]
},
{
"name": "Tariffs",
"description": "Reseller pricing catalog and currency tariffs.",
"item": [
{
"name": "Get All tariffs",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/tariffs/get?count=&page=",
"host": [
"{{base_url}}"
],
"path": [
"tariffs",
"get"
],
"query": [
{
"key": "count",
"value": "",
"description": "This parameter lets you specify the amount of tariffs to return in your API call. The default for this parameter (if it isn't specified) is 20 tariffs. The maximum amount of tariffs you can have returned to you via this parameter is 100."
},
{
"key": "page",
"value": "",
"description": "Used to page through the tariffs. Every call to this endpoint will return a has_more key with a bool value. If this value is true, then send {page} +1 to get the next page of tariffs."
}
]
},
"description": "Gets all tariffs for an Account."
},
"response": [
{
"name": "200 Success Response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{base_url}}/tariffs/get?count=&page=",
"host": [
"{{base_url}}"
],
"path": [
"tariffs",
"get"
],
"query": [
{
"key": "count",
"value": "",
"description": "This parameter lets you specify the amount of tariffs to return in your API call. The default for this parameter (if it isn't specified) is 20 tariffs. The maximum amount of tariffs you can have returned to you via this parameter is 100."
},
{
"key": "page",
"value": "",
"description": "Used to page through the tariffs. Every call to this endpoint will return a has_more key with a bool value. If this value is true, then send {page} +1 to get the next page of tariffs."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"status\": \"OK\",\n \"result\": [\n {\n \"tariffs\": [\n {\n \"id\": 123,\n \"...\": \"...\"\n }\n ],\n \"has_more\": true\n }\n ]\n}"
}
]
}
]
}
]
}