OneSky Platform API

OneSky Platform API provides programmatic access to OneSky's platform management.

The new API

This is new Platform API and is not compatible with the Classic API. This new API covers most of the endpoints of classic API with numerous of new endpoints added and will continue to be actively developed going forward.

Resources

Project

• Project Group
• Project
• Project Type

String

• File
• Translation
• Phrase Collection
• Phrase Collection Attachment
• Import Task
• Screenshot

Order

• Quotation
• Order

Language

• Locale

Authentication

All of the endpoints require you to authenticate. You will have to find your own API key and API secret. First login to oneskyapp and find the API key and secret in Site Settings under API Keys & Usage.

Parameters

Name	Type	Description
api_key	string	Your own API key
timestamp	integer	Current unix timestamp
dev_hash	string	Calculate with timestamp and api_secret Formula: md5(concatenate(<timestamp>, <api_secret>))

Request

We accept request data in JSON format. Please specify request header with content-type: application/json and encode the data in JSON format.

SSL is applied to protect all request data. Make sure you are using https to initiate request.

Response

Response body will be in JSON format with 2 objects.

• meta contains the metadata of the response and additional information such as status code, total record count, paginations, etc...
• data contains the data from your request such as project information, file information, etc...

Currently, we only support JSON data format in response.

Success

Successful request will response with 2xx status code together with response body if there is. Details of response body is shown at the bottom of each endpoints.

Failure

Failure request will response with an error status code together with an error message.

Example:

status 400 bad request

{
  "meta": {
    "status": 400,
    "message": "Your request cannot be processed"
  },
  "data": {}
}