API: Customer API

In this section, you will learn how to create, query, update and delete customers. You can use the Customers feature to change translations for one company or user without altering your base translations.

Table of contents

• Resources

• Create a customer

  • Sample request
  • Request fields
  • Example response

• Get customer

  • Sample request
  • Example response

• Get all customers

  • Sample request
  • Example response

• Update customer

  • Sample request
  • Example response

• Delete customer

  • Sample request
  • Example response

Resources

• What are customer-specific translations?
• Add translation for customer by passing customer key in customerKey field
• Update customer translations by passing customer key in customerKey field
• Get customer translations from CDN (recommended) by passing customer key in URL
• Get customer translations from API by passing customer key in customerKey field

Create a customer

Sample request

curl
    --location
    --request POST 'https://api.simplelocalize.io/api/v1/customers' \
    --header 'X-SimpleLocalize-Token: <API_KEY>' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "key": "my-customer-2137",
        "description": "My favourite customer is just reading this text ☺️"
    }'

Request fields

• key (required) - customer identifier, must be unique for a project (max 40 characters),
• description (optional) - more details about the customer (max 255 characters),

Example response

{
  "msg": "OK",
  "status": 200,
  "data": {
    "key": "my-customer-2137",
    "description": "My favourite customer is just reading this text ☺️"
  }
}

Get customer

Sample request

curl
    --location
    --request GET 'https://api.simplelocalize.io/api/v1/customers/{customerKey}' \
    --header 'X-SimpleLocalize-Token: <API_KEY>' \
    --header 'Content-Type: application/json'

Example response

{
  "msg": "OK",
  "status": 200,
  "data": {
    "key": "my-customer-2137",
    "description": "My favourite customer is just reading this text :)"
  }
}

Get all customers

Endpoint returns all available customers in the project.

Sample request

curl
    --location
    --request GET 'https://api.simplelocalize.io/api/v1/customers' \
    --header 'X-SimpleLocalize-Token: <API_KEY>' \
    --header 'Content-Type: application/json'

Example response

{
  "msg": "OK",
  "status": 200,
  "data": [
    {
      "key": "my-customer-2137",
      "description": "My favourite customer is just reading this text :)"
    },
    {
      "key": "my-customer-1004",
      "description": "Some description for my-customer-1004"
    }
  ]
}

Update customer

Sample request

curl
    --location
    --request PATCH 'https://api.simplelocalize.io/api/v1/customers/my-customer-2137' \
    --header 'X-SimpleLocalize-Token: <API_KEY>' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "key": "my-customer-2137-modified",
        "description": "My favourite customer is just reading this text ☺️"
    }'

Example response

{
  "msg": "OK",
  "status": 200,
  "data": {
    "key": "my-customer-2137-modified",
    "description": "My favourite customer is just reading this text :)"
  }
}

Delete customer

Sample request

curl
    --location
    --request DELETE 'https://api.simplelocalize.io/api/v1/customers/my-customer-2137' \
    --header 'X-SimpleLocalize-Token: <API_KEY>' \
    --header 'Content-Type: application/json'

Example response

{
  "msg": "OK",
  "status": 200
}