You use this integration guide when you want to download your keys from eclypse via our API.


HTTP Method

POST


HTTP Headers

HTTP request header must include your access token and the content-type should be marked as json.

ApiKey: abc....xyz
Content-Type: application/json

HTTP Body

The body (payload) should be in JSON format. The body (payload) should be in JSON format. Read the Export Keys Schema for all available options.

Example:

{
    "projectName": "rosette",
    "languageCodes": "en_US", "ko", "it_IT"
}

HTTP Response

eclypse returns the export keys response in JSON format. The full schema definition can be found here.

Example

{
  "data": [
    {
      "key": "master piece",
      "description": "",
      "isPlural": false,
      "capitalization": 10,
      "customAttributes": {
        "aaaa": "bbb",
        "ccc": "ddd"
      },
      "translations": [
        {
          "isBase": true,
          "languageCode": "en_GB",
          "pluralForm": "one",
          "translation": "how many legends are listening to this masterpiece?"
        },
        {
          "isBase": false,
          "languageCode": "ar_EH",
          "pluralForm": "one",
          "translation": "كم عدد الأساطير الذين يستمعون إلى هذه التحفة؟"
        }
      ]
    }
  ]
}

See also

Export Request Schema

Import Response Schema

Create Access Token