WritePath Translation API (PHP, Java)

Intro

For a quick & easy start with our API, simply use the class we provide below or download it from Github (PHP, Java). It takes care of authorization, JSON encoding and decoding and it can do a few more very convenient things.

How to get your API keys? Sign up here and request the API keys in the settings section of your account.

We use JSON. Every response looks like this:

                    {
                        "response": {

                        },
                        "opStatus": "ok"
                        }

If something has gone wrong, the response looks like this:

                {
                    "response": {
                    "errorCode": "4001",
                    "errorMessage": "Something has gone wrong"
                    },
                    "opStatus": "error"
                    }

You can use the error codes to map the error in your own application.

Methods

The following document describes the operations you will be able to execute with the WritePath Translation API.

Get word count of plain text (POST)
Get word count of document (POST)
Post a job with plain text (POST)
Post a job with document(POST)
Fetch job status(POST)
Fetch current word balance of your account(POST)
Post a comment (POST)
Post multiple jobs with plain text(POST) (POST)
Fetch multiple job status (jobs posted by above)(POST)

Get word count of plain text(POST)

Summary: Receive the word count of the a text string. Text can include basic HTML tags which won't be counted.
URL: https://www.writepath.co/api/wordcount
Authentication: Required

Parameters

api_key	required	Your public API key
private_key	required	Your private API key
service	required	The service you require: 1 = editing, 2 = translation only, 4 = premium translation (translation + editing)
langID	required	The id of the translation / editing language. Click here to see the list of available languages.
text	required	the text you would like to have translated or edited. Can include HTML tags, these are not counted as words.

Example call

                    include 'WritepathClient.php';

                    

                    $api_key = '12345678';

                    $private_key = 'ABCDEFGH';

                    

                    $service = '2'; // i.e. Standard Translation

                    $langID = '5'; // i.e. English - Chinese (Simplified)

                    $text = 'My very long text';

                    

                    $WritepathClient = new WritepathClient($api_key, $private_key);

                    $reply = $WritepathClient->getWordCountPlainText($service, $langID, $text);

Response

                {
                "response": {
                "wordCount": "710"
                },
                "opStatus": "ok"
                }

Get word count of document (POST)

Summary: Receive the word count of the text in a document (.docx, .pptx, .xlsx). Text can include basic HTML tags which won't be counted.
URL: https://www.writepath.co/api/wordcount
Authentication: Required

Parameters

api_key	required	Your public API key
private_key	required	Your private API key
service	required	The service you require: 1 = editing, 2 = translation only, 4 = premium translation (translation + editing)
langID	required	The id of the translation / editing language. Click here to see the list of available languages.
filename	required	The path + filename of your document (only .docx, .pptx, .xlsx)

                    include 'WritepathClient.php';

                    

                    $api_key = '12345678';

                    $private_key = 'ABCDEFGH';

                    

                    $service = '2'; // i.e. Standard Translation

                    $langID = '5'; // i.e. English - Chinese (Simplified)

                    $filename = 'c:/mydoc.docx';

                    

                    $WritepathClient = new WritepathClient($api_key, $private_key);

                    $reply = $WritepathClient->getWordCountDocument($service, $langID, $filename);

Response

                {
                "response": {
                "wordCount": "710"
                },
                "opStatus": "ok"
                }

Post a job with plain text (POST)

Summary: Send a job with plain text to the service. The calculated word count will be deducted from your account and the case made available to translators/editors who match the category of your job. Use the method Get word count of plain text first, if you want to get a quote before you post a job.
URL: https://www.writepath.co/api/job
Authentication: required

Parameters

api_key	required	Your public API key
private_key	required	Your private API key
service	required	The service you require: 1 = editing, 2 = translation only, 4 = premium translation (translation + editing)
langID	required	The id of the translation / editing language. Click here to see the list of available languages.
category	required	The category / topic your text is about. Click here to see a list of available categories.
text	required	the text you would like to have translated or edited. Can include HTML tags, these are not counted as words.
instructions	optional	instructions for the translator / editor.
notify_url	optional	When job is finished, a REST post is sent to that URL

Example call

                    include 'WritepathClient.php';

                    

                    $api_key = '12345678';

                    $private_key = 'ABCDEFGH';

                    

                    $service = '2'; // i.e. Standard Translation

                    $langID = '5'; // i.e. English - Chinese (Simplified)

                    $category = '3'; // i.e. Technology

                    $text = 'My very long text';

                    $instructions = 'here are my instructions';

                    $notify_url = 'http://www.mydomain.com/notify_me.php';

                    

                    $WritepathClient = new WritepathClient($api_key, $private_key);

                    $reply = $WritepathClient->sendPlainText($service, $langID, $category, $text, $instructions, $notify_url);

Response

                {
                "response": {
                "wordsUsed": "710",
                "orderId": "411"
                },
                "opStatus": "ok"
                }

Post a job with a document(POST)

Summary: Send a job with file attachment to the service. Supported file types: .docx, .xlsx, .pptx. The calculated word count will be deducted from your account and the case made available to translators/editors who match the category of your job. Use the method Get word count of document first, if you want to get a quote before you post a job.
URL: https://www.writepath.co/api/job
Authentication: required

Error code	Error message
1000	Authentication failed
1100	api_key is a required field
1150	private_key is a required field
1200	ts - timestamp is a required field
1201	ts - timestamp must be numeric
1250	data is a required field
1251	JSON data cannot be decoded
1252	type is a required field and can only be 1 or 2
1800	job is a required field
1801	comment is a required field
1802	file upload failed (did you check that the file is correct and the extension supported?)
1803	Wrong file type
1804	Wrong job id
1805	No words in document
1806	No words in plain text
1807	Can't write to file
1808	File too big. Max. 15MB allowed
2700	Not enough word credits - please top up
3000	body or document - only one field can be set
3001	Neither body nor document are set - set one
3002	Service type, language ID and category must be provided
3003	Wrong category
3004	Wrong service
3005	Wrong language ID
3006	Service and language ID do not match
3007	Copy writing service not supported in API
3008	all parameters are requested
3009	need filename with document
3010	need array of text
4000	Can not add comment: job has not been claimed yet
4001	Job unknown: check id
4002	No result
4003	API format doesn't match with your upload format (1=file, 2=plain text)