TQAuditor API Documentation

The API is in early development stage and is subject to change without notice at any time. Be prepared to update your code accordingly.

General information

The requests should be directed to "https://api.tqauditor.com/v1/". All requests must specify the API key as a query parameter "api_key" of request URL. The API key is available on Account details page of TQAuditor main site for account owners only. Only accounts with active license (including trial accounts) can access the API. POST requests accept request parameters in "application/x-www-form-urlencoded" and/or "multipart/form-data" (see specific request descriptions for details). GET requests expect parameters to be passed as query parameters of request URL.

Error reporting

The API calls report errors with appropriate HTTP status codes. The response body returned have "application/json" content type and contains a JSON object with at least a "message" field describing the error and possibly some additional fields with more error details.

List of requests

account/view

Returns the information about TQAuditor account with the specified API key.

Method: GET
Parameters: none
Example response:
{
  "id": 123456,
  "name": "Account Name"
}

file/compare

Compares a pair of bilingual files and returns an Excel .xlsx file with comparison report.

Method: POST
Request content type: "multipart/form-data"
Parameters: "oldFile", "newFile" - files to compare
Response content type: "application/octet-stream"

project/create

Creates a new project.

Method: POST
Request content type: "application/x-www-form-urlencoded"
Parameters:

The following parameters are required: "spec[name]", "sourceLang[tag]", "targetLang[tag]", "manager[first_name]", "manager[last_name]", "translator[first_name]", "translator[last_name]", "evaluator[first_name]", "evaluator[last_name]" are required. Project evaluator cannot be the same person as project translator.

Response content type: "application/json"
Example request:
tms_translation_code=TC&tms_evaluation_code=EC&sourceLang[tag]=en&targetLang[tag]=ru&spec[name]=Medical&evaluator[first_name]=Name1&evaluator[last_name]=Name1&translator[first_name]=Name2&translator[last_name]=Name2&manager[first_name]=Name3&manager[last_name]=Name3&note_for_evaluator=NoteText
Example response:
{created project information (see project/view response)}

project/mistake-counts

Returns the number of mistakes per mistake type and severity for TQAuditor project specified with parameter "id".

Method: GET
Parameters: "id" - specifies the ID of the project to return information for
Response content type: "application/json"
Example response: 
[
	{
		"type": {"name": "Accuracy"},
		"severity": {"name": "Non-scoring"},
		"count": 0
	},
	{
		"type": {"name": "Accuracy"},
		"severity": {"name": "Minor"},
		"count": 2
	},
	{
		"type": {"name": "Accuracy"},
		"severity": {"name": "Major"},
		"count": 0
	},
	{
		"type": {"name": "Grammar"},
		"severity": {"name": "Non-scoring"},
		"count": 1
	},
	{
		"type": {"name": "Grammar"},
		"severity": {"name": "Minor"},
		"count": 5
	},
	{
		"type": {"name": "Grammar"},
		"severity": {"name": "Major"},
		"count": 0
	},
	{
		"type": {"name": "Spelling"},
		"severity": {"name": "Non-scoring"},
		"count": 0
	},
	{
		"type": {"name": "Spelling"},
		"severity": {"name": "Minor"},
		"count": 0
	},
	{
		"type": {"name": "Spelling"},
		"severity": {"name": "Major"},
		"count": 0
	}
]

project/index

Returns the information about all TQAuditor projects.

Method: GET
Parameters: Response content type: "application/json"
Example response:
[{data for project1 (see project/view request)}, {data for project2}, ...]

project/view

Returns the information about TQAuditor project specified with parameter "id".

Method: GET
Parameters: "id" - specifies the ID of the project to return information for
Response content type: "application/json"
Example response: 
{
	"id": 1234,
	"client": {
		"name": "Google"
	},
	"tms_project_code": "P53272",
	"tms_translation_code": "J123-7",
	"tms_evaluation_code": "J456-8",
	"name": "Test project",
	"spec": {
		"name": "Misc"
	},
	"service": {
		"name": "TEP"
	},
	"sourceLang": {
		"tag": "en"
	},
	"targetLang": {
		"tag": "ru"
	},
	"manager": {
		"first_name": "Name1",
		"last_name": "Name1",
		"company": "Company1Name"
	},
	"translator": {
		"first_name": "Name2",
		"last_name": "Name2",
		"company": "Company2Name"
	},
	"evaluator": {
		"first_name": "Name3",
		"last_name": "Name3",
		"company": "Company3Name"
	},
	"arbiter": {
		"first_name": "Name4",
		"last_name": "Name4",
		"company": "Company1Name"
	},
	"word_count_for_evaluator": null,
	"note_for_evaluator": "",
	"evaluator_time_limit": 24,
	"translator_time_limit": 12,
	"arbiter_time_limit": 24,
	"stage_id": 1,
	"evaluation_summary": "Good overall.",
	"evaluation_count": 0,
	"score": 100,
	"mark": "Outstanding",
	"created_at": "2019-08-21 15:58:01"
}
Current stage of the project ("stage_id") can have one of the following values:
1 - Files upload
2 - Comparison
3 - Evaluation
4 - Translator's review
5 - Arbitration
6 - Completed

project/upload

Uploads multiple bilingual translated and reviewed files into the specified project. See Supported bilingual file types at Quick compare page for a list of supported bilingual file formats.

Method: POST
Request content type: "multipart/form-data"
Parameters:

The files with duplicate filenames within a set of translated or a set of reviewed files are not accepted. All successfully parsed files will be added to the project even if some of the files have failed to parse.