Skip to content

Latest commit

 

History

History
157 lines (125 loc) · 5.23 KB

README.md

File metadata and controls

157 lines (125 loc) · 5.23 KB
Raw

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.

Authentication

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.

API Access

This Platform API is available for organizations subscribed to STARTER or above plans.

Parameters

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>))

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": {}
}

For more authentication error troubleshooting, please see this article.

Resources

Project

  • Project Group
    • LIST all project groups
    • SHOW project group details
    • CREATE a new project group
    • DELETE a project group
    • list enabled LANGUAGES
  • Project
    • LIST projects of a project group
    • SHOW project details
    • CREATE a new project
    • UPDATE a project
    • DELETE a project
    • list LANGUAGES of a project
  • Project Type
    • LIST all project types

String

  • File
    • LIST uploaded files
    • UPLOAD a file
    • DELETE a file
  • Translation
    • EXPORT translations in files
    • export translations in MULTILINGUAL files
    • export translations of APP STORE Description
    • GET translation status
  • Import Task
    • LIST import tasks
    • SHOW import task

Order

  • Quotation
    • SHOW a quotation
  • Order
    • LIST all orders
    • SHOW order details
    • CREATE an order

Language

Wrappers

PHP

PHP Symphony

Python

Ruby

Rails

Grunt

Node.js

  • nodejs-onesky-utils - Brainly (A known issue with the error message { 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