Customer

Self-Service API for Personal Data Management

The 'Customers' section of the Babel Licensing Service API represents a dedicated interface for external customers holding the 'Customer' role. This API is uniquely tailored not for the administrative management of customer data, but for empowering customers to access and modify their own information from a personal perspective. It serves as a self-service portal where customers can manage their details, preferences, and licensing information.

Get

Roles: Customer

The GET method for the endpoint is designed for customers to access their personal information using their unique customer code. When a customer inputs their specific code, this method retrieves a comprehensive view of their profile, including contact details.

Retrieves a customer by their code.

GET/v1/customer/{customerCode}

Path parameters

customerCode*string

customer_code is the code of the customer.

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

customerCustomer (object)

Defines a customer in Babel Licensing.

Request

JavaScriptCurl

const response = await fetch('/v1/customer/{customerCode}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "customer": {
    "title": "text",
    "firstName": "text",
    "lastName": "text",
    "company": "text",
    "code": "text",
    "vatCode": "text",
    "invoiceCode": "text",
    "createdAt": "text",
    "updatedAt": "text",
    "address": "text",
    "address1": "text",
    "address2": "text",
    "postalCode": "text",
    "region": "text",
    "city": "text",
    "country": "text",
    "countryCode": "text",
    "mapCoordinates": "text",
    "mapZoomLevel": 0,
    "email": "text",
    "phone": "text",
    "mobile": "text",
    "fax": "text",
    "website": "text",
    "notes": "text",
    "isReseller": false,
    "image": "text",
    "contacts": [
      {
        "title": "text",
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "phone": "text",
        "mobile": "text",
        "fax": "text",
        "details": "text"
      }
    ]
  }
}

Put

Roles: Customer

The PUT method at the same endpoint enables customers to update their personal information. By using their unique customer code, customers can securely modify details such as contact information, preferences, or other relevant personal data.

Updates a customer by their code.

PUT/v1/customer/{customerCode}

Path parameters

customerCode*string

customer_code is the code of the customer.

Body

application/json

customerCodestring

customer_code is the code of the customer.

customerCustomer (object)

Defines a customer in Babel Licensing.

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

Request

JavaScriptCurl

const response = await fetch('/v1/customer/{customerCode}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}