api 1
api 2api 3 api 4 api 5
api 6
{
"response": {
},
"opStatus": "ok"
}
api 7
{
"response": {
"errorCode": "4001",
"errorMessage": "Something has gone wrong"
},
"opStatus": "error"
}
api 8 api 9 api 10
api 11
api 12
- api 13 (POST)
- api 14 (POST)
- api 15 (POST)
- api 16(POST)
- api 17(POST)
- api 18(POST)
- api 19 (POST)
- api 176 (POST)
- api 177(POST)
api 20
- api 21
- api 22
- api 23
- https://www.writepath.co/api/wordcount
- api 24
api 25
api 26
| api_key | api 27 | api 28 |
| api 29 | api 30 | api 31 |
| service | api 32 | api 33 |
| langID | api 34 | api 35 api 36. |
| text | api 37 | api 38 |
api 39
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);
api 40
{
"response": {
"wordCount": "710"
},
"opStatus": "ok"
}
api 41
- api 42
- api 43
- URL
- https://www.writepath.co/api/wordcount
- api 44
- api 45
api 46
| api_key | api 47 | api 48 |
| private_key | api 49 | api 50 |
| service | api 51 | api 52 |
| langID | api 53 | api 54 api 55. |
| filename | api 56 | api 57 |
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);
api 58
{
"response": {
"wordCount": "710"
},
"opStatus": "ok"
}
api 59
- api 60
- api 61 api 62 api 63
- URL
- https://www.writepath.co/api/job
- api 64
- api 65
api 66
| api_key | api 67 | api 68 |
| private_key | api 69 | api 70 |
| service | api 71 | api 72 |
| langID | api 73 | api 74 api 75. |
| category | api 76 | api 77 api 78. |
| text | api 79 | api 80 |
| instructions | api 81 | api 82 |
| notify_url | api 83 | api 84 |
api 85
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);
api 86
{
"response": {
"wordsUsed": "710",
"orderId": "411"
},
"opStatus": "ok"
}
api 87
- api 88
- api 89 api 90. api 91 api 92 api 93
- URL
- https://www.writepath.co/api/job
- api 94
- api 95
- api 118
- api 119
- URL
- https://www.writepath.co/api/job/{id}
- api 120
- api 121
- api 136
- api 137
- URL
- https://www.writepath.co/api/balance
- api 138
- api 139
- api 148
- api 149
- URL
- https://www.writepath.co/api/jobs/{id}/comment
- api 150
- api 151
- api 42
- api 179
- URL
- https://www.writepath.co/api/bjobs
- api 44
- api 45
- api 118
- api 119
- URL
- https://www.writepath.co/api/bjob/{id}
- api 120
- api 121
api 96
| api_key | api 97 | api 98 |
| private_key | api 99 | api 100 |
| service | api 101 | api 102 |
| langID | api 103 | api 104 api 105. |
| category | api 106 | api 107 api 108. |
| filename | api 109 | api 110 |
| instructions | api 111 | api 112 |
| notify_url | api 113 | api 114 |
api 115
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
$filename = 'c:/mydoc.docx';
$instructions = 'here are my instructions';
$notify_url = 'http://www.mydomain.com/notify_me.php';
$WritepathClient = new WritepathClient($api_key, $private_key);
$reply = $WritepathClient->sendDocument($service, $langID, $category, $filename, $instructions, $notify_url);
api 116
{
"response": {
"wordsUsed": "710",
"orderId": "411"
},
"opStatus": "ok"
}
api 117
api 122
| api_key | api 123 | api 124 |
| private_key | api 125 | api 126 |
| id | api 127 | api 128 |
| format | api 129 | api 130 |
api 131
include 'WritepathClient.php';
$api_key = '12345678';
$private_key = 'ABCDEFGH';
$id = '379';
$format = '1';
$WritepathClient = new WritepathClient($api_key, $private_key);
$reply = $WritepathClient->getStatus($id, $format);
api 132
{
"response": {
"wordsUsed": "710",
"status": "finished",
"dueDate": "1384570722",
"wordsBalance": "532",
"commentFinished": "",
"document": "A4BDLP0..." (base64)
},
"opStatus": "ok"
}
api 133
{
"response": {
"wordsUsed": "710",
"status": "finished",
"dueDate": "1384570722",
"wordsBalance": "532",
"commentFinished": "",
"document": "this is the translated text"
},
"opStatus": "ok"
}
api 134
api 135
api 140
| api_key | api 141 | api 142 |
| private_key | api 143 | api 144 |
api 145
include 'WritepathClient.php';
$api_key = '12345678';
$private_key = 'ABCDEFGH';
$WritepathClient = new WritepathClient($api_key, $private_key);
$reply = $WritepathClient->getWordBalance();
api 146
{
"response": {
"wordsBalance": "522"
},
"opStatus": "ok"
}
api 147
api 152
| api_key | api 153 | api 154 |
| private_key | api 155 | api 156 |
| id | api 157 | api 158 |
api 159
include 'WritepathClient.php';
$api_key = '12345678';
$private_key = 'ABCDEFGH';
$WritepathClient = new WritepathClient($api_key, $private_key);
$reply = $WritepathClient->postComment(379,'this is a comment for job #379');
api 160
{
"response": {
},
"opStatus": "ok"
}
api 178
api 46
| api_key | api 47 | api 48 |
| private_key | api 49 | api 50 |
| service | api 51 | api 52 |
| langID | api 53 | api 54 api 55. |
| category | api 76 | api 77 api 78. |
| text | api 79 | api 180 |
| instructions | api 81 | api 82 |
| notify_url | api 83 | api 84 |
include 'WritepathClient.php';
$api_key = '12345678';
$private_key = 'ABCDEFGH';
$service = '2'; // i.e. Standard Translation
$langID = '6'; // i.e. English - Chinese (Traditional)
$category = '3'; // i.e. Technology
$text = {'My very long text','My very long another 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);
api 86
{"batchId":"31","response":[{"wordsUsed":"250","orderId":"40184"},{"wordsUsed":"3","orderId":"40186"}],"opStatus":"ok"}
api 181
api 122
| api_key | api 123 | api 124 |
| private_key | api 125 | api 126 |
| id | api 127 | api 128 |
| format | api 129 | api 184 |
api 131
include 'WritepathClient.php';
$api_key = '12345678';
$private_key = 'ABCDEFGH';
$id = '31';
$format = '2';
$WritepathClient = new WritepathClient($api_key, $private_key);
$reply = $WritepathClient->getBatchedStatus($id, $format);
api 132
{"batchId":31,"response":[{"wordsUsed":"250","status":"working","dueDate":"1487402914","wordsBalance":"1000","commentFinished":null,"document":null},{"wordsUsed":"3","status":"finished","dueDate":"1487402914","wordsBalance":"1000","commentFinished":"test","document":"this is the translated text"}],"opStatus":"ok"}
api 133
{
"response": {
"wordsUsed": "710",
"status": "finished",
"dueDate": "1384570722",
"wordsBalance": "532",
"commentFinished": "",
"document": "this is the translated text"
},
"opStatus": "ok"
}
api 134
api 161
api 162
api 165
api 166
{
"response": {
"orderId": "2345",
"wordsUsed": "764",
"status": "finished",
"dueDate": "1405747052",
"commentFinished": null,
"A4BDLP0..." (base64)
},
"opStatus": "ok"
}
api 167
api 168
{
"response": {
"orderId": "2345",
"comment": "this is my comment",
"date": 1405561885
},
"opStatus": "ok"
}
api 169
api 170
| api 171 | api 172 |
| 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) |
api 173
api 174 Ver. 1.2 Deprecated
api 175 Ver. 1.2 Deprecated
api 174 Ver. 1.3
api 175 Ver. 1.3
