FunTranslations Braille API
Braille conversion API on the cloud
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"swagger": "2.0",
"schemes": [
"https",
"http"
],
"host": "api.funtranslations.com",
"info": {
"contact": {
"name": "Fun Translations",
"url": "https://funtranslations.com/api/braille",
"x-twitter": "funtranslate"
},
"description": "Braille conversion API on the cloud. Translate from English text to Braille and get Braille results suitable for many display types.[Click here to subscribe](http://funtranslations.com/api/braille) \n",
"termsOfService": "https://funtranslations.com/terms",
"title": "FunTranslations Braille API",
"version": "2.3",
"x-apisguru-categories": [
"text"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_twitter.com_funtranslate_profile_image.png"
},
"x-origin": [
{
"format": "swagger",
"url": "https://funtranslations.com/yaml/funtranslations.braille.yaml",
"version": "2.0"
}
],
"x-providerName": "funtranslations.com",
"x-serviceName": "braile"
},
"consumes": [
"application/json"
],
"produces": [
"application/json",
"application/xml",
"application/js"
],
"securityDefinitions": {
"X-Funtranslations-Api-Secret": {
"in": "header",
"name": "X-Funtranslations-Api-Secret",
"type": "apiKey"
}
},
"tags": [
{
"description": "Braille Translation API",
"externalDocs": {
"description": "Find out more",
"url": "http://funtranslations.com/api/braille"
},
"name": "Braille"
}
],
"paths": {
"/translate/braille": {
"get": {
"description": "Translate from English to Braille. This is what you use if you have a braille display. This API translates the English text into characters that a braille display understands and you can feed the translated text directly to the display.",
"parameters": [
{
"description": "Text to translate",
"format": "string",
"in": "query",
"name": "text",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"application/xml",
"application/js"
],
"responses": {
"200": {
"description": "200 response",
"examples": {
"application/json": "{\n \"success\": {\n \"total\": 1\n },\n \"contents\": {\n \"translated\": \" ,fun ,transl,ns has \\\"s?+ =\\r\\n\\\"ey\\\"o4\\r\\n\",\n \"text\": \"Fun Translations has something for everyone.\",\n \"translation\": {\n \"source\": \"english\",\n \"destination\": \"braille display\"\n }\n }\n}"
}
},
"401": {
"description": "401 response",
"examples": {
"application/json": "{\n \"error\": {\n \"code\": 401,\n \"message\": \"Unauthorized\"\n }\n} "
}
}
},
"security": [
{
"X-Funtranslations-Api-Secret": []
}
],
"tags": [
"Braille"
]
}
},
"/translate/braille/dots": {
"get": {
"description": "Use this to see which dots are enabled for each Braille letters. This is highly educational (to see which dots are enabled) and can potentially drive a non braille display which works on individual dots.",
"parameters": [
{
"description": "Text to translate",
"format": "string",
"in": "query",
"name": "text",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"application/xml",
"application/js"
],
"responses": {
"200": {
"description": "200 response",
"examples": {
"application/json": "{\n \"success\": {\n \"total\": 1\n },\n \"contents\": {\n \"translated\": [\n \"none\",\n \"none\",\n \"6\",\n \"124\",\n \"136\",\n \"1345\",\n \"none\",\n \"6\",\n \"2345\",\n \"1235\",\n \"1\",\n \"1345\",\n \"234\",\n \"123\",\n \"6\",\n \"1345\",\n \"234\",\n \"none\",\n \"125\",\n \"1\",\n \"234\",\n \"none\",\n \"5\",\n \"234\",\n \"1456\",\n \"346\",\n \"none\",\n \"123456\",\n \"\\r\",\n \"\\n\",\n \"5\",\n \"15\",\n \"13456\",\n \"5\",\n \"135\",\n \"256\",\n \"\\r\",\n \"\\n\"\n ],\n \"text\": \"Fun Translations has something for everyone.\",\n \"translation\": {\n \"source\": \"english\",\n \"destination\": \"braille dots\"\n }\n }\n}"
}
},
"401": {
"description": "401 response",
"examples": {
"application/json": "{\n \"error\": {\n \"code\": 401,\n \"message\": \"Unauthorized\"\n }\n} "
}
}
},
"security": [
{
"X-Funtranslations-Api-Secret": []
}
],
"tags": [
"Braille"
]
}
},
"/translate/braille/html": {
"get": {
"description": "Translate from English to Braille Image characters. This is probably what you want to use if you are displaying braille in a browser.",
"parameters": [
{
"description": "Text to translate",
"format": "string",
"in": "query",
"name": "text",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"application/xml",
"application/js"
],
"responses": {
"200": {
"description": "200 response",
"examples": {
"application/json": "{\n \"success\": {\n \"total\": 1\n },\n \"contents\": {\n \"translated\": [\n \"⠀\",\n \"⠀\",\n \"⠠\",\n \"⠋\",\n \"⠥\",\n \"⠝\",\n \"⠀\",\n \"⠠\",\n \"⠞\",\n \"⠗\",\n \"⠁\",\n \"⠝\",\n \"⠎\",\n \"⠇\",\n \"⠠\",\n \"⠝\",\n \"⠎\",\n \"⠀\",\n \"⠓\",\n \"⠁\",\n \"⠎\",\n \"⠀\",\n \"⠐\",\n \"⠎\",\n \"⠹\",\n \"⠬\",\n \"⠀\",\n \"⠿\",\n \"\\r\",\n \"\\n\",\n \"⠐\",\n \"⠑\",\n \"⠽\",\n \"⠐\",\n \"⠕\",\n \"⠲\",\n \"\\r\",\n \"\\n\"\n ],\n \"text\": \"Fun Translations has something for everyone.\",\n \"translation\": {\n \"source\": \"english\",\n \"destination\": \"braille html\"\n }\n }\n}"
}
},
"401": {
"description": "401 response",
"examples": {
"application/json": "{\n \"error\": {\n \"code\": 401,\n \"message\": \"Unauthorized\"\n }\n} "
}
}
},
"security": [
{
"X-Funtranslations-Api-Secret": []
}
],
"tags": [
"Braille"
]
}
},
"/translate/braille/image": {
"get": {
"description": "Translate from English to Braille image characters. This is probably what you want to use if you are displaying braille in a browser.",
"parameters": [
{
"description": "Text to translate",
"format": "string",
"in": "query",
"name": "text",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"application/xml",
"application/js"
],
"responses": {
"200": {
"description": "200 response",
"examples": {
"application/json": "{\n \"success\": {\n \"total\": 1\n },\n \"contents\": {\n \"translated\": [\n \"<img src='http://funtranslations.com/img/braille/char/00.gif' alt='char 0x2800 = ⠀' title='char 0x2800 = ⠀' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/00.gif' alt='char 0x2800 = ⠀' title='char 0x2800 = ⠀' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/20.gif' alt='char 0x2820 = ⠠' title='char 0x2820 = ⠠' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/0b.gif' alt='char 0x280b = ⠋' title='char 0x280b = ⠋' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/25.gif' alt='char 0x2825 = ⠥' title='char 0x2825 = ⠥' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/1d.gif' alt='char 0x281d = ⠝' title='char 0x281d = ⠝' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/00.gif' alt='char 0x2800 = ⠀' title='char 0x2800 = ⠀' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/20.gif' alt='char 0x2820 = ⠠' title='char 0x2820 = ⠠' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/1e.gif' alt='char 0x281e = ⠞' title='char 0x281e = ⠞' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/17.gif' alt='char 0x2817 = ⠗' title='char 0x2817 = ⠗' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/01.gif' alt='char 0x2801 = ⠁' title='char 0x2801 = ⠁' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/1d.gif' alt='char 0x281d = ⠝' title='char 0x281d = ⠝' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/0e.gif' alt='char 0x280e = ⠎' title='char 0x280e = ⠎' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/07.gif' alt='char 0x2807 = ⠇' title='char 0x2807 = ⠇' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/20.gif' alt='char 0x2820 = ⠠' title='char 0x2820 = ⠠' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/1d.gif' alt='char 0x281d = ⠝' title='char 0x281d = ⠝' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/0e.gif' alt='char 0x280e = ⠎' title='char 0x280e = ⠎' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/00.gif' alt='char 0x2800 = ⠀' title='char 0x2800 = ⠀' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/13.gif' alt='char 0x2813 = ⠓' title='char 0x2813 = ⠓' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/01.gif' alt='char 0x2801 = ⠁' title='char 0x2801 = ⠁' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/0e.gif' alt='char 0x280e = ⠎' title='char 0x280e = ⠎' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/00.gif' alt='char 0x2800 = ⠀' title='char 0x2800 = ⠀' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/10.gif' alt='char 0x2810 = ⠐' title='char 0x2810 = ⠐' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/0e.gif' alt='char 0x280e = ⠎' title='char 0x280e = ⠎' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/39.gif' alt='char 0x2839 = ⠹' title='char 0x2839 = ⠹' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/2c.gif' alt='char 0x282c = ⠬' title='char 0x282c = ⠬' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/00.gif' alt='char 0x2800 = ⠀' title='char 0x2800 = ⠀' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/3f.gif' alt='char 0x283f = ⠿' title='char 0x283f = ⠿' class='img-braille-char'>\",\n \"\\r\",\n \"\\n\",\n \"<img src='http://funtranslations.com/img/braille/char/10.gif' alt='char 0x2810 = ⠐' title='char 0x2810 = ⠐' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/11.gif' alt='char 0x2811 = ⠑' title='char 0x2811 = ⠑' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/3d.gif' alt='char 0x283d = ⠽' title='char 0x283d = ⠽' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/10.gif' alt='char 0x2810 = ⠐' title='char 0x2810 = ⠐' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/15.gif' alt='char 0x2815 = ⠕' title='char 0x2815 = ⠕' class='img-braille-char'>\",\n \"<img src='http://funtranslations.com/img/braille/char/32.gif' alt='char 0x2832 = ⠲' title='char 0x2832 = ⠲' class='img-braille-char'>\",\n \"\\r\",\n \"\\n\"\n ],\n \"text\": \"Fun Translations has something for everyone.\",\n \"translation\": {\n \"source\": \"english\",\n \"destination\": \"braille images\"\n }\n }\n}"
}
},
"401": {
"description": "401 response",
"examples": {
"application/json": "{\n \"error\": {\n \"code\": 401,\n \"message\": \"Unauthorized\"\n }\n} "
}
}
},
"security": [
{
"X-Funtranslations-Api-Secret": []
}
],
"tags": [
"Braille"
]
}
},
"/translate/braille/unicode": {
"get": {
"description": "Translate from English to Braille Unicode characters.",
"parameters": [
{
"description": "Text to translate",
"format": "string",
"in": "query",
"name": "text",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"application/xml",
"application/js"
],
"responses": {
"200": {
"description": "200 response",
"examples": {
"application/json": "{\n \"success\": {\n \"total\": 1\n },\n \"contents\": {\n \"translated\": [\n \"⠀\",\n \"⠀\",\n \"⠠\",\n \"⠋\",\n \"⠥\",\n \"⠝\",\n \"⠀\",\n \"⠠\",\n \"⠞\",\n \"⠗\",\n \"⠁\",\n \"⠝\",\n \"⠎\",\n \"⠇\",\n \"⠠\",\n \"⠝\",\n \"⠎\",\n \"⠀\",\n \"⠓\",\n \"⠁\",\n \"⠎\",\n \"⠀\",\n \"⠐\",\n \"⠎\",\n \"⠹\",\n \"⠬\",\n \"⠀\",\n \"⠿\",\n \"\\r\",\n \"\\n\",\n \"⠐\",\n \"⠑\",\n \"⠽\",\n \"⠐\",\n \"⠕\",\n \"⠲\",\n \"\\r\",\n \"\\n\"\n ],\n \"text\": \"Fun Translations has something for everyone.\",\n \"translation\": {\n \"source\": \"english\",\n \"destination\": \"braille unicode\"\n }\n }\n}"
}
},
"401": {
"description": "401 response",
"examples": {
"application/json": "{\n \"error\": {\n \"code\": 401,\n \"message\": \"Unauthorized\"\n }\n} "
}
}
},
"security": [
{
"X-Funtranslations-Api-Secret": []
}
],
"tags": [
"Braille"
]
}
}
}
}