OneSky Platform API provides programmatic access to OneSky's platform management.
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.
All of the endpoints require you to authenticate. You will have to find your own API key and API secret. First login to OneSky and find the API key.
This Platform API is available for organizations subscribed to STARTER or above plans.
| Name | Type | Description |
api_key |
string | Your own API public key |
timestamp |
integer | Current unix timestamp (GMT+0) in seconds |
dev_hash |
string |
Calculate with timestamp and api_secret
Formula: md5(concatenate(<timestamp>, <api_secret>))
|
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 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.
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 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": {}
}For more authentication error troubleshooting, please see this article.
Project
String
Order
Language
PHP
PHP Symphony
Python
Ruby
Rails
Grunt
Node.js
{ message: 'Unable to fetch document', code: 500 } has been identified. To address this issue, a workaround has been proposed here. We recommend that users apply the provided patch before utilizing the package)Go
C#
.NET
Elixir