You use this integration guide when you want to insert or update your keys in 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. Read the Import Keys Schema for all options.
Example:
{
"projectName": "rosette",
"keys": [
{
"key": "rhythmic_dancers",
"mergeRule": "replace",
"isPlural": false,
"customAttributes": {
"key1": "value1",
"key2": "value2"
},
"tags": [
"tagId1",
"tagId2",
"tagId3"
],
"translations": [
{
"languageCode": "en_GB",
"translation": "dancers are finding their rhythm."
}
]
},
{
"key": "guitar_making",
"mergeRule": "merge",
"translations": [
{
"languageCode": "en",
"translation": "A guitar luthier repairs guitars."
}
]
}
]
}HTTP Response
Import Keys API allows partial successes. This means, the API will return Success (200) even if some keys are not processed due to errors. In order to account for partial success, the API contract is shaped as below:
{
"importedKeys": [
"string",
"string"
],
"rejectedKeys": [
{
"key": "string",
"rejectionReason": "string",
"errorCode": 698
}
]
}The schema of the ImportKeys Response API can be accessed here.