isabella232 / api-documentation-plugin

OneSky Plugin API

OneSky Plugin API provides programmatic access to OneSky's translation service.

Endpoints

Account Resources

• POST sign-up
• POST sign-in
• GET credit

Locale Resources

• GET locales

Specialization Resources

• GET specializations

Project Resources

• GET projects
• POST projects

Order Resources

• GET orders
• GET orders/:id
• GET orders/:id/items
• GET orders/:id/messages
• POST orders

Quotation Resources

• POST quotations

Language Pair Resources

• GET language-pair

Authentication

All of the endpoints require you to do authentication. 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

• string api_key

  Your own API key

• int timestamp

  Current unix timestamp

• string dev_hash

  Calculate with api_secret and timestamp

  Formula: md5(concatenate(<timestamp>, <api_secret>))

Request

We accept request data in JSON format. Please specify request header with Content-Type: application/json; charset=utf-8 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

Successful request will response with either 200 or 201 status code togehter with response data if there is. When there is a new record created, 201 Created will be used. Otherwise, 200 OK will apply.

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

{ "code": 400, "message": "Your request cannot be processed" }

Currently, we only support JSON data format encoded in UTF-8 charset in response.