We've made our RESTful API to be really easy to you implement. Our goal is that with a simple HTTP request, you can translate your text!
\nRight below there is a brief overview of how to implement our API, and after, a more in-depth description of each implementation detail.
\nYou will see that our API is very easy to implement!
\nSee how it's easy and fast to implement:
\nAPI Key Below are all the details about the API Key.JSON object with the translation data you want to perform. That is: your text, and the languages of the source text and the desired translation.POST request, passing this data.Done! In the response of this request will be the translation result.
\nTo keep it extremally simple, we use only 1 endpoint! Simply make a HTTP request using the POST method for the endpoint (URL):
https://api.gotit.ai/Translation/v1.1/Translate\nTo achive maximum development while ensuring stability, we use the versioning system directly in the EndPoint's URL. Note that in the example above, the most recent current version is specified: v1.1.
If no version is specified, the execution will be performed using the oldest not obsolete version (currently v1.1). Example:
https://api.gotit.ai/Translation/Translate\n
If only the major version is specified, without the minor version, execution will be performed using the specified major version and the minor oldest non-obsolete version (for v1: currently v1.1). Example:
https://api.gotit.ai/Translation/v1/Translate\n
Please note: Currently the most recent version is v1.1. We recommend that you always specify the exact version to ensure maximum stability. Also stay tuned in our blog, emails and the Got It AI newsletter. Through them, we will keep you informed of the advances in our technology and new versions available!
Requests using the GET method will not be accepted, or any other method than POST. Requests for this endpoint that do not use the POST method will receive the HTTP status code 401 Unauthorized in response, indicating an unauthorized access error.
All requests must be executed using the HTTPS protocol. Requests that are made with the HTTP protocol only, without using a secure connection, will receive the HTTP 401 Unauthorized` status code, indicating an unauthorized access error.
Every request needs to be authenticated. To do so, you will pass your API Key on each request you make. Below we explain what a API Key is, how you get yours, and how you put it in your request.
If you are an expert, I will give a more straightforward explanation: you will use the Basic Authentication scheme of the HTTP protocol, passing your API Key, in the Authorization header of the request.
The API Key is your access credential, like a password, used only to perform the translation on our API.
Your API Key is different from your Got It AI password. Your password is only for managing your Got It AI account. Your API Key is another separate credential, which is the only credential you will pass to our API on your request.
Each API Key is composed of a pair of strings, as if it were an \"username and password\" pair. The API Key is composed of the pair:
API Key, as if it were an username/loginAPI Key, as if it were a passwordAPI Key example:
Identifier: 86-jIqiXoug\nSecret: soOW1VchGaSMYIKwE4tr5q5KmjGb4uCvft2CFuSg\nThis example API Key will be used several times during this documentation. Your API Key will be similar to it. You can use all the examples in this documentation by just replacing the API Key example with your API Key.
API KeyWhen you register on the Got It AI website, you will receive the a password to administer your account on our site. Also, it'll be asked to you validade your email address. Once you did that, you can enter in the Got It AI website, Sign In with your password in the administrative area, and your API Key will be available there.
You may also create new API Keys, or even revoke any compromised API Key in the administrative area of our site.
While the administrative area is not available, feel free to contact our support staff to request new API Keys, or revoke a compromised one.
We chose to use authentication with API Keys, because it allows two very important things:
API Key are different credentials.API Key will be used. If for any reason someone accesses this credential, your information on your Got It AI account will be secure.API Key!API Key for each application that accesses our API. Thus, if an one of your applications is compromised, only that API Key will be compromised, and only that one will be revoked. That way, all your other API Keys and the applications that use them will be safe, and won't suffer downtime.To authenticate your request, use the Authorization header in your HTTP request. This header can be used with many different schemas, but for our API we gonna use the most simple and easy of them, the Basic Authentication one.
Using Basic Authentication on the header Authorization is very easy.\nYou will set the value of your Authorization header to Basic <your API converted to Base64>.
That is, you will literally write Basic, including the space at the end, plus your API Key (Identifier and Secret, concatenated with a : between them), converted to Base64.
API Key:
Identifier: 86-jIqiXoug\nSecret: soOW1VchGaSMYIKwE4tr5q5KmjGb4uCvft2CFuSg\nYou will concatenate the username and password (in this case Identifier and Secret respectively) using a : (colon) between the two. It'll be like this:
86-jIqiXoug:soOW1VchGaSMYIKwE4tr5q5KmjGb4uCvft2CFuSg
Now just convert this string to base64. It'll be like this:
\n ODYtaklxaVhvdWc6c29PVzFWY2hHYVNNWUlLd0U0dHI1cTVLbWpHYjR1Q3ZmdDJDRnVTZw==
Now just concatenate the Basic string (including the space) with the converted API Key. It'll be like this:
Basic ODYtaklxaVhvdWc6c29PVzFWY2hHYVNNWUlLd0U0dHI1cTVLbWpHYjR1Q3ZmdDJDRnVTZw==
Set the Authorization header to the value of step 3 in your request. This header in your HTTP POST request looks like this:
Authorization: Basic ODYtaklxaVhvdWc6c29PVzFWY2hHYVNNWUlLd0U0dHI1cTVLbWpHYjR1Q3ZmdDJDRnVTZw==
Done! Your request is authenticated!
\nThe standard Basic Authentication scheme works with username and password, concatenated using a: (colon) between them. In our implementation, the equivalent username is the API Key Identifier and the equivalent password is the API Key Secret.
If you do not know the Basic Authentication scheme of the Authorization header just google these terms. There are excellent explanations that i'm sure will answer any questions you have.
If you don't know how or have questions about how to implement the HTTP POST request setting the Authorization header, we have provided excellent code examples on our webpage. Of course, you also can always search Google on how to create a POST request, and how to set the Authorization header specifically for your programming language. These are very simple terms, with a lot of good stuff about them.
Our service levels will meet the following minimum requirements:
\n99.9% uptime online availability.
\nBelow there are several code blocks in different languages to help you get started right now! Just copy and paste the code of your desired language, and edit it inserting your own API Key (by replacing #APIKey_Identifier# with your API Key Identifier and #APIKey_Secret# with your API Key Secret), and done!
import json\nimport requests\nimport pprint\nimport base64\n\nurl = 'https://api.gotit.ai/Translation/v1.1/Translate'\ndata = {\"T\":\"Victor ate a delicious pizza.\",\"SL\":\"EnUs\",\"TL\":\"PtBr\"}\ndata_json = json.dumps(data)\nuserAndPass = base64.b64encode(b\"#APIKey_Identifier#:#APIKey_Secret#\").decode(\"ascii\")\nheaders = {'Content-type': 'application/json', \"Authorization\": \"Basic %s\" % userAndPass}\nresponse = requests.post(url, data=data_json, headers=headers)\npprint.pprint(response.json())\nstatic async Task MainAsync()\n{\n // ... Use HttpClient.\n HttpClient client = new HttpClient();\n\n var byteArray = Encoding.ASCII.GetBytes(\"#APIKey_Identifier#:#APIKey_Secret#\");\n client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Basic\", Convert.ToBase64String(byteArray));\n\n var data = new { T = \"Victor ate a delicious pizza.\", SL = \"EnUs\", TL = \"PtBr\" };\n var content = new StringContent(JsonConvert.SerializeObject(data), Encoding.UTF8, \"application/json\");\n\n HttpResponseMessage response = await client.PostAsync(\"https://api.gotit.ai/Translation/v1.1/Translate\", content);\n HttpContent responseContent = response.Content;\n\n // ... Check Status Code \n Console.WriteLine(\"Response StatusCode: \" + (int)response.StatusCode);\n\n // ... Read the string.\n string result = await responseContent.ReadAsStringAsync();\n}\npublic static void main(String[] args) throws ClientProtocolException, IOException, JSONException {\n String url = \"https://api.gotit.ai/Translation/v1.1/Translate\";\n\n HttpClient client = HttpClientBuilder.create().build();\n HttpPost post = new HttpPost(url);\n\n String authString = \"#APIKey_Identifier#\" + \":\" + \"#APIKey_Secret#\";\n String authStringEnc = new String(Base64.getEncoder().encodeToString(authString.getBytes()));\n\n post.addHeader(\"Content-Type\",\"application/json\");\n post.addHeader(\"Authorization\",\"Basic \" + authStringEnc);\n\n JSONObject data = new JSONObject();\n data.put(\"T\", \"Victor ate a delicious pizza.\"); \n data.put(\"SL\", \"EnUs\"); \n data.put(\"TL\", \"PtBr\"); \n\n post.setEntity(new StringEntity(data.toString(), ContentType.APPLICATION_JSON));\n\n HttpResponse response = client.execute(post);\n\n BufferedReader rd = new BufferedReader(new InputStreamReader(response.getEntity().getContent()));\n\n StringBuffer result = new StringBuffer();\n String line = \"\";\n while ((line = rd.readLine()) != null) {\n result.append(line);\n }\n\n System.out.println(result.toString());\n}\n$headers = array(\n \"Content-type: application/json\",\n \"Authorization: Basic \". base64_encode(\"#APIKey_Identifier#:#APIKey_Secret#\")\n);\n\n$data_array = array();\n$data_array [\"T\"] = \"Victor ate a delicious pizza.\";\n$data_array [\"SL\"] = \"EnUs\";\n$data_array [\"TL\"] = \"PtBr\";\n$data = json_encode($data_array );\n\n$options = array (\n 'http' => array (\n 'header' => $headers,\n 'method' => 'POST',\n 'content' => $data\n )\n);\n$context = stream_context_create ($options);\n$result = file_get_contents ('https://api.gotit.ai/Translation/v1.1/Translate', false, $context);\n\n$result = json_decode($result, true);\nrequire 'net/http'\nrequire 'uri'\n\nuri = URI.parse(\"https://api.gotit.ai/Translation/v1.1/Translate\")\nrequest = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')\nrequest.basic_auth(\"#APIKey_Identifier#\", \"#APIKey_Secret#\")\nrequest.body = {T: 'Victor ate a delicious pizza.', SL: 'EnUs', TL: 'PtBr'}.to_json\n\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == \"https\") do |http|\nhttp.request(request)\n\nend\nTo perform the text translation, simply execute the HTTPS request, using the POST method, sending in the body of the request the JSON example object, passing 3 parameters:
T - Source text encoded in UTF-8\n
\nSL - Source text's language code\n
\nTL - Desired language code for translation\n
The currently supported language codes for both the Source Text and the Desired Translation are:
\nEnUs - English (United States / International)\n
\nEsEs - Spanish\n
\nPtBr - Brazilian Portuguese\n
\nZhCh - Chinese (Simplified)\n
\nDeAl - German\n
\nFrFr - French\n
\nRuRu - Russian\n
\nArAr - Arabic\n
Below is a complete example of the request:
\nPOST /Translation/v1.1/Translate HTTP/1.1\nHost: api.gotit.ai\nContent-Type: application/json\nAuthorization: Basic ODYtaklxaVhvdWc6c29PVzFWY2hHYVNNWUlLd0U0dHI1cTVLbWpHYjR1Q3ZmdDJDRnVTZw==\n\n{\n \"T\": \"Victor ate a delicious pizza.\",\n \"SL\": \"EnUs\",\n \"TL\": \"PtBr\"\n}\n