How Does API Work?
The Transliteration API will use the REV-APP-ID and REV-API-KEY to authenticate requests. Your credentials carry many privileges, so be sure to keep them secure.-
Pass valid login credentials:
REV-APP-IDREV-API-KEY
- Select Source language & Target language
- Post Source Content
- Validate user credentials & load default account settings
- Return content in Target language
cURL for Integration
Translate content to one target language
Request
Response
Transliterating Multiple sentences
Request
Response
API References
HTTP Request URL
Headers
A unique key/token provided by Reverie to identify the user using the Localization API.
- The version refers to the specific iteration of the API that is being called.
- Note: The default version is 2.0.
- The script used in the input text.
- Example :
or,hi,bn - Refer to section Language Codes for valid language code.
- The script to which you want to convert the input text.
- Example :
or,hi,bn - Refer to section Language Codes for valid language code.
- The Domain refers to the universe in which you use the Transliteration . Example- Health Care, Insurance, Legal, etc.
- Refer to section Domain Codes for valid language code.
- The language of the words in the input text.
- Refer to section Supported Language for valid language code.
- Example:
data: "Singh Sahab aap Kahan the."
In the example above, the Hindi language words are written in the English language script (Roman Script). Socnt_lang = "hi". - Note: This is an optional parameter. If no value is provided, by default the value is the same as
src_lang.
Request
- Specify whether the API should initially search in the Exception DB to transliterate the input text.
- Note - By default, the
isBulk=trueand will not search in the Exception DB.
- Mention the number of transliteration suggestions the API should return for the input text.
- Note - By default, the
noOfSuggestions= 1, means the API will return only one transliteration suggestion for the input string. - Example: Consider
noOfSuggestions = 2
- The abbreviate will Validate whether any Abbreviations/ Acronyms are passed in the input text and will transliterate it accurately.
- Note - By default, the
abbreviate=true - Note - If the value is false, the API will consider the abbreviation as a word and transliterate it to the nearest available word.
- Note - In the input text, pass the abbreviations in upper case.
- The feature to screen the non-dictionary words used in a sentence. In other words, the mask will indicate the words that should not be translated into the target language.
- Note - By default, the
enableLookup=true. - Note - To set the
nmtMask=true, it is mandatory thesrc_lang=en(English). - Description: Specify whether to convert the numbers in the input text to the target language script based on the value type.
- Three types of values for this parameter:
- local: This value can convert the input number to the target language script.
Example: - words: This value can convert numbers into words with respect to the target language.
Example: - roman: This value can convert Roman numbers to English numbers.
Example:- If the user types
sector Vin English, the transliteration would beसेक्टर 5in Hindi. Block IIwill be transliterated asब्लॉक 2.
- If the user types
- local: This value can convert the input number to the target language script.
- Specify whether you want to retain the entities like email ID and URL in the input script.
- Note: By default, the
ignoreTaggedEntities=trueand will transliterate the email ID and URL into the target language script. - Example: Consider
ignoreTaggedEntities = false
- This is used for transliterating ordinal values to English numbers.
- Note - Default value =
False. - Example: If the user types
15th Mainin English, the transliteration would be15 मेनin Hindi.
- This is used to produce the abbreviation output without a dot.
- Note - Default value =
False. - Example: If a user wants an abbreviation output without a dot and is given
SMSas an input, then the result would beएसएमएस.
Response
- Status of API – successful/fail.
- By default, the
api_status= 2 for all the successful transactions.