fie.nipa Help: kasahorow Dictionaries API Documentation


1. kasahorow Dictionaries API Documentation
   1. API Overview
   2. HTTP Request
   3. GET Methods
   4. Output Format
      1. HTML
         1. Variables
      2. JSON
         1. Parameters
   5. Example Codes

kasahorow Dictionaries API Documentation
kasahorow exposes some of it data via an Application Programming Interface( API ). This document serve as a reference guide for anyone interested in knowing and using the API.

API Overview
The kasahorow API is a REST API. At the moment it gives back two formatted responses, HTML and JSON, which means, when you make an HTTP request, you get back a JSON formatted data or an HTML depending on the format you request for. In the near future we hope to support other formats like XML too.

HTTP Request
The kasahorow API only supports the HTTP GET method. As at now, you can only retrieve data but cannot actually post or delete data with the API. As more need for them prevails, we will provide support for them.

GET Methods
The only GET method the kasahorow API provide is the get.links method, which does translation of a word from one language to the other.

Output Format
As stated earlier, the kasahorow API, gives back two formatted outputs, HTML and JSON. If you want the kasahorow API to give you a formatted HTML output then make a request for an HTML output but if you want to format the output yourself, then request for a JSON output.

HTML
The HTML output was specifically designed for people who want to embed the kasahorow API output directly into their website without writing so much code to get the right data from the output. It requires writing a few Javascript code by declaring the variables documented below.

Example Codes
A typical HTML formatted output code. This is a Javascript code in an HTML file.

Variables
If you want HTML as the output, then you need to declare these javascript variables in an HTML file, like the example code above.

kclient_key - This variable, accepts a valid fienipa account username. Example,"fie.nipa"
kclient_lim - The number of results to show. Example, "5"
kclient_db - "en";
kclient_link = "sw";
kclient_dom - The kasahorow API URL. Its a required field. Always this "http://api.fieniap.com/". We will remove this in the near future.
kclient_query - The word to be translated. They can be UTF-8 words. Example, "dog"
kclient_height - The height of the output. Example, "500"
kclient_width - The width of the output. Example, "800"
kclient_il = This is the language to display the user interface( UI ) in. If you want the UI strings to be in Akan, then its value will be "ak";
kclient_cat - The parts of speech comma separated by a terminology. Example, "noun,cat"

JSON
JSON is also an output format, designed for advanced users who want to have much control over the kasahorow API output. With this output format, you need to write code to decode the JSON data. Hence more control on what you want to do with the data.

Example Codes
A typical JSON formatted output. All you need to do is construct a URL that looks like this.
http://api.fienipa.com/?q=kjson&method=get.links&args=dog,en,ak&key=fien...

Parameters
You need to add these parameters to the kasahorow API URL.
kasahorow API URL = http://api.fienipa.com/?q=kjson

&method - This is the get method. Which is always get.links
&args - This parameter needs the word to be translated, followed by the language to be translated from and then the language to translate to. Example, dog,en,ak
&key - A valid fienipa account username. Example,"fie.nipa"
&format - The output you want the response in. Example, "json"