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

Authorizations

Path parameters

customerCodestringrequired

customer_code is the code of the customer.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/customer/{customerCode}' \
  --header 'x-api-key: YOUR_API_KEY'

200

default

200

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

Success

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

Authorizations

Path parameters

customerCodestringrequired

customer_code is the code of the customer.

Body

customerCodestringoptional

customer_code is the code of the customer.

customerobjectoptional

Defines a customer in Babel Licensing.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v1/customer/{customerCode}' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "customerCode": "text",
    "customer": {
      "id": 1,
      "title": "text",
      "firstName": "text",
      "lastName": "text",
      "company": "text",
      "code": "text",
      "vatCode": "text",
      "invoiceCode": "text",
      "rating": 1,
      "createdAt": "text",
      "updatedAt": "text",
      "address": "text",
      "address1": "text",
      "address2": "text",
      "postalCode": "text",
      "region": "text",
      "city": "text",
      "country": "text",
      "countryCode": "text",
      "mapCoordinates": "text",
      "mapZoomLevel": 1,
      "email": "text",
      "phone": "text",
      "mobile": "text",
      "fax": "text",
      "website": "text",
      "notes": "text",
      "isReseller": true,
      "image": "text",
      "contacts": [
        {
          "id": 1,
          "title": "text",
          "firstName": "text",
          "lastName": "text",
          "email": "text",
          "phone": "text",
          "mobile": "text",
          "fax": "text",
          "details": "text",
          "customerId": 1
        }
      ]
    }
  }'

application/json

200

default

200

{
  "success": true,
  "code": 1,
  "message": "text"
}

Success