List all my project and items

The response contains:

A list of all project IDs and a list of all item IDs of each project.

Example

Here we see that there is project 1 (containing 3 items), project 2 (containing 5 items) and project 3 (containing no item). The shown number for the items is your item ID.

Note: Deleted items won't be shown here.

{
  "1": {
    "items": [
      1,
      3,
      5
    ]
  },
  "2": {
    "items": [
      1,
      2,
      3,
      4,
      5
    ]
  },
  "3": {
    "items": []
  }
}

Remember: Each project has its own item counting so item 1 of the first project is NOT the same as item 1 in the second project.

Fetch information about a project.

Check if a project has already been translated or receive your translation from this endpoint.

The response contains:

• description: the project description
• items: A list of items you send in
• files: A list of IDs for files that were appended to the project.
  • data: The translation of an item (empty if not yet translated).
• data: The translations (empty if not yet translated).

Files should be fetched using the file endpoint. This make those big data streams a bit more stable.

Example

Receiving a project:

 GET project/123.json

 {
     "description": "the project description", (can be null)
     "items": {
           "1": {
               "__meta": {
                   ... what you send in ...
               },
              "status": ""
           },
           "2": {
               "__meta": {
                   ... what you send in ...
               },
              "status": "new"
           },
           "3": {
               "__meta": {
                   ... what you send in ...
               },
              "status": "finished"
           }
     },
 }

Sandbox

For development you can override some headers which will simulate different states.

Fetch information about a project item.

Get information about the project item you've sended or check for its translations. The data will come back to you just like you've provided them.

Examples

Fetching a project item again (after its translation) has the same structure as you send it in:

 GET /api/v1/project/55/item/5

 {
     "__meta": {
         "some": "thing",
         "you" : "need"
     },
     "description": "... some translation ...",
     "complex"    : ["the","keys","stay"],
     "but"        : "all values will be translated."
 }

As you can see the original data will be provided to. Maybe you like to have them for comparison, if the original text has changed.

Receive original text

To receive the original text you can add some value for the X-With-Origin header:

 GET /api/v1/project/55/item/5
 X-With-Origin: Yes

 {
     "__meta": {
         "some": "thing",
     },

     "__origin": {
             "description": "Some arbitrary structure.",
             "complex"    : ["as","you","like"],
             "but"        : "json at last."
     },

     "description": "... some translation ...",
     "complex"    : ["the","keys","stay"],
     "but"        : "all values will be translated."
 }

Now the original (source) text will be present in the request too:

Fetch translation of a file.

Once a file has been translated it can be fetched using this endpoint.

Response

The response will contain the send in headers and the original filename. Example:

 X-Source:   'en-us'
 X-Target:   'fr-fr'
 X-TextType: 'product'
 X-Filename: 'same-as-send.in'

Fetch available languages.

A list of allowed text types.

The key is of your interest. The value is a description what is really meant and how our workflow is.

This is a test action to show you that authorization worked.

Provide the header field "apikey" with your credentials.