Page History
Excerpt | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1.Web API CommandsOverview
Depending on your tasks and needs, you can form and send your API requests using GET or POST methods. Below you will find templates for both request methods. 1.1. Template of Request URL using GET
1.2.Check Spelling CommandTemplate of Request URL using POST
2. Check Spelling Command
Here is a list of all possible parameters and values that can be used with the check_spelling command.
Example 2.1: Check Spelling Request using GET (Output in XML)
Parameters:
Request Response:
Example 2.2: Check Spelling Request (Output in JSON)Here is a sample of the POST request to check spelling for a given piece of text.
Request Body: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter | Value | cmd |
:2880/?cmd=check_spelling |
&format=json&text=This sampl text demonstrates the work of the WebSpellChecker Web API service.&out_type=words&slang=en_US |
Parameters:
- Command: check_spelling
- Format: JSON
- Text: “This sampl text demonstrates the work of the WebSpellChecker Web API service.”
- Output: words
- Language: American English (en_US)
Request Response:
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="utf-8"?> <check_spelling> [ { "word": "sampl", <misspelling> "ud": false, <word>sampl</word> "suggestions": [ <ud>false</ud> <suggestions>"sample", <suggestion>sample</suggestion>"sampled", <suggestion>sampled</suggestion>"sampler", <suggestion>sampler</suggestion>"samples", <suggestion>samples</suggestion>"ample", <suggestion>ample</suggestion>"amply", <suggestion>amply</suggestion>"scamp", <suggestion>scamp</suggestion>"stamp" <suggestion>stamp</suggestion>] </suggestions> </misspelling> </check_spelling>} ] |
Example 2.
23: Check Spelling Request using POST (Output in JSON)
Here we use the same request and parameters as described in example above but form it as a POST request.
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name:2880/? |
Code Block | ||
---|---|---|
| ||
/spellcheck/script/ssrv.fcgi?cmd=check_spelling&format=json&text=This sampl text demonstrates the work of the WebSpellChecker Web API service.&out_type=words&slang=en_US |
Parameters:
en_US |
Request Response:
Code Block | ||||
---|---|---|---|---|
| ||||
[ { "word": "sampl", "ud":" false",, "suggestions": [ "sample", "sampled", "sampler", "samples","ample", "ample", "amply", "scamp", "stamp" ] } ] |
3. Grammar Check Command
Info |
---|
Command name: grammar_check |
Here is a list of all possible parameters and values that can be used with the grammar_check command.
# | Parameter | Possible Values | Default Value | Description | |
---|---|---|---|---|---|
1 | format |
| xmljson | The parameter set a response format for output data. | |
2 | callback |
| The parameter specifies a callback function name that will be used to manipulate with the JSON data received from the server. Such approach enables sharing of data bypassing same-origin policy. It can be used only along with “format=json”. | ||
3 | text |
| The parameter defines a text which will be sent for grammar checking. The text has to be in the UTF-8 encoding. Any found tags in the text will be interpreted as a plan text as well. | ||
4 | slang |
| en_US | The parameter sets a shot code of a language which will be used for grammar checking. Note | |
Example 3.1: Grammar Check Request using GET (output in XML)
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name/spellcheck/script/ssrv.fcgi:2880/?cmd=grammar_check&format=xml&text=Webweb API provides a gramar checking command that will help you builds a custom solution.&slang=en_US |
Parameters:
- Command: grammar_check
- Format: XML
- Text: “Web API provides a gramar checking command that will help you builds a custom solution.”
- Language: American English (en_US)
Request Response:
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="utf-8"?> <grammar_check> <grammar_problem> <phrase>you builds</phrase> <description>Pronoun "you" conflicts with verb "builds."</description> <problem_id>437780848</problem_id> <suggestions> <suggestion>you build</suggestion> <suggestion>you, builds</suggestion> </suggestions> </grammar_problem> </grammar_check> |
Example 3.2: Grammar
Check RequestCheck Request using GET (Output in JSON)
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name/spellcheck/script/ssrv.fcgi?cmd=grammar_check&format=json&text=Web API provides a gramar checking command that will help you builds a custom solution.&slang=en_US |
Parameters:
- Command: grammar_check
- Format: JSON
- Text: “Web API provides a gramar checking command that will help you builds a custom solution.”
- Language: American English (en_US)
Request Response:
Code Block | ||||
---|---|---|---|---|
| ||||
[ {"phrase "sentence": "web API provides a gramar checking command that will help you builds","description":"Pronoun \"you\" conflicts with verb \"builds.\"","problem_id":"437780848", "suggestions":["you build","you, builds"]}] |
4. User Dictionary Command
Info |
---|
Command name: user_dictionary |
Here is a list of all possible parameters and values that can be used with the user_dictionary command.
- json
- xml
a custom solution",
"matches": [
{
"message": "This sentence does not start with an uppercase letter",
"offset": 0,
"length": 3,
"rule": {
"id": "UPPERCASE_SENTENCE_START"
},
"suggestions": [
"Web"
]
}
]
}
] |
Example 3.3: Grammar Check Request using POST (Output in JSON)
Here we use the same request and parameters as described in example above but form it as a POST request.
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name:2880/? |
Code Block | ||
---|---|---|
| ||
cmd=grammar_check&format=json&text=web API provides a gramar checking command that will help you builds a custom solution.&slang=en_US |
Request Response:
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"sentence": "web API provides a gramar checking command that will help you builds a custom solution",
"matches": [
{
"message": "This sentence does not start with an uppercase letter",
"offset": 0,
"length": 3,
"rule": {
"id": "UPPERCASE_SENTENCE_START"
},
"suggestions": [
"Web"
]
}
]
}
] |
4. User Dictionary Command
Info |
---|
Command name: user_dictionary |
Here is a list of all possible parameters and values that can be used with the user_dictionary command.
# | Parameter | Possible Values | Default Value | Description |
---|---|---|---|---|
1 | format |
| json | The parameter sets a response format for output data. |
2 | callback |
| The parameter specifies a callback function name that will be used to manipulate with the JSON data received from the server. Such approach enables sharing of data bypassing same-origin policy. It can be used only along with “format=json”. | |
3 | action |
| The parameter defines an action that can be used to manipulate a user dictionary. |
Here is a list of all possible parameters and values that can be used with the user_dictionary action parameter.
# | Action Parameter | Parameters | Possible Values | Description | ||
---|---|---|---|---|---|---|
1 | create | name |
| The action that creates a new user dictionary. | ||
wordlist |
| |||||
2 | delete | name |
| The action that deletes a selected user dictionary. | ||
3 | rename | name |
| The action that renames a specified dictionary and sets a new name. | ||
new_name |
| |||||
4 | check | name |
| The action that checks if a specified user dictionary exists on the server. | ||
5 | getdict | name |
| The action requests content of a specified user dictionary.
| ||
6 | addword | name |
| The action adds new word(s) to a specified user dictionary. If you are adding more than one word at a time, all new words must be separated with commas accordingly. | ||
word |
| |||||
7 | deleteword | name |
| The action removes a word from a specified user dictionary. | ||
word |
| |||||
8 | editword |
- callback function name
- create – Create a new user dictionary.
- rename – Rename an existing user dictionary.
- delete – Delete an existing user dictionary.
- addword – Add a new word to a specified user dictionary.
- deleteword – Remove a word from a specified user dictionary.
- editword – Edit a word in a specified user dictionary.
- check – Check if a specified user ductionary exists on the server.
- getdict – Get content of a specified user dictionary (for JSON only).
Here is a list of all possible parameters and values that can be used with the user_dictionary action parameter.
# | Action Parameter | Parameters | Possible Values | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | create | name |
| The action that creates a new user dictionary. | ||||||||
wordlist |
| |||||||||||
2 | delete | name |
| The action that deletes a selected user dictionary. | ||||||||
3 | rename | name |
| The action that remanes a specified dictionary and sets a new name. | ||||||||
new_name |
| |||||||||||
4 | checkname |
| The action | that checks ifreplaces a word in a specified user dictionary | exists on the serverwith a new one. | 5 | getdict | name |
|
Note |
---|
The getdict action is available only for the JSON format. |
- name of a chosen user dictionary
- a new word which will be added to a specified user dictionary
- name of a chosen user dictionary
- word which will be removed from a specified user dictionary
- name of a chosen user dictionary
- word which will be edited
- a new word which replaces a word picked for editing
Example 4.1: Create User Dictionary (XML)
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name/spellcheck/script/ssrv.fcgi?cmd=user_dictionary&format=xml&action=create&name=user_dictionary&wordlist=SCAYT, SpellCheckAsYouType, WSC, WebSpellChecker, Proofreader |
Parameters:
- Command: user_dictionary
- Action: Create
- Name: “user_dictionary”
- Wordlist: “SCAYT, SpellCheckAsYouType, WSC, WebSpellChecker, Proofreader”
- Format: XML
Request Response:
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="utf-8"?>
<dictionary>
<name>user_dictionary</name>
<action>create</action>
</dictionary> |
word |
|
new_word |
|
Example 4.1: Create User Dictionary (XML)
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name:2880/?cmd=user_dictionary&format=xml&action=create&name=user_dictionary&wordlist=SCAYT, SpellCheckAsYouType, WSC, WebSpellChecker, WProofreader |
Parameters:
- Command: user_dictionary
- Action: Create
- Name: “user_dictionary”
- Wordlist: “SCAYT, SpellCheckAsYouType, WSC, WebSpellChecker, Proofreader”
- Format: XML
Request Response:
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="utf-8"?>
<dictionary>
<name>user_dictionary</name>
<action>create</action>
</dictionary> |
Example 4.2: Get User Dictionary Content (JSON)
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name:2880/?cmd=user_dictionary&format=json&action=getdict&name=user_dictionary |
Parameters:
- Command: user_dictionary
- Action: getdict
- Name: “user_dictionary”
- Format: JSON
Request Response:
Code Block | ||||
---|---|---|---|---|
| ||||
{"name":"user_dictionary","action":"getdict","wordlist":["SCAYT"," SpellCheckAsYouType"," WSC"," WebSpellChecker"," Proofreader"]}
{
"name": "user_dictionary",
"action": "getdict",
"wordlist": [
"SCAYT",
"SpellCheckAsYouType",
"WSC",
"WebSpellChecker",
"WProofreader"
],
"modificationTime": 1571762101
} |
Example 4.3: Get User Dictionary Content using POST (Output in JSON)
Using the same request and parameters as described in example 4.2 but form it as a POST request.
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name:2880/? |
Code Block | ||
---|---|---|
| ||
/spellcheck/script/ssrv.fcgi?cmd=user_dictionary&format=json&action=getdict&name=user_dictionary |
Parameters:
- Command: user_dictionary
- Action: getdict
- Name: “user_dictionary”
- Format: JSON
=user_dictionary |
Request Response:
Code Block | ||||
---|---|---|---|---|
| ||||
{ "name": "user_dictionary", "action": "getdict", "wordlist":["SCAYT"," SpellCheckAsYouType"," WSC"," WebSpellChecker"," Proofreader"] [ "SCAYT", "SpellCheckAsYouType", "WSC", "WebSpellChecker", "WProofreader" ], "modificationTime": 1571762101 } |
5. Get Languages List Command
Info |
---|
Command name: get_lang_list |
Example 5.1: Get Languages List (JSON)
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name/spellcheck/script/ssrv.fcgi?cmd=:2880/?cmd=get_lang_list |
Parameters:
- Command: get_lang_list
Note |
---|
By default, the output format for get_lang_ list |
Parameters:
- Command: get_lang_list
Note |
---|
By default the output format for get_lang_list command is JSON. |
Request Response:
list command is JSON. |
Request Response:
Code Block | ||||
---|---|---|---|---|
| ||||
{
"langList": {
"ltr": {
"en_US": "American English",
"en_GB": "British English",
"fr_FR": "French",
"it_IT": "Italian",
"de_DE": "German",
"es_ES": "Spanish",
"pt_BR": "Brazilian Portuguese",
"da_DK": "Danish",
"nl_NL": "Dutch",
"nb_NO": "Norwegian Bokmal",
"pt_PT": "Portuguese",
"sv_SE": "Swedish",
"el_GR": "Greek",
"en_CA": "Canadian English",
"fr_CA": "Canadian French",
"fi_FI": "Finnish",
"uk_UA": "Ukrainian"
},
"rtl": {}
}
| ||||
Code Block | ||||
| ||||
{"langList":{"ltr":{"en_US" : "American English","en_GB" : "British English","fr_FR" : "French","de_DE" : "German","it_IT" : "Italian","es_ES" : "Spanish","pt_BR" : "Brazilian Portuguese","da_DK" : "Danish","nl_NL" : "Dutch","nb_NO" : "Norwegian Bokmål","pt_PT" : "Portuguese","sv_SE" : "Swedish","el_GR" : "Greek","en_CA" : "Canadian English","fr_CA" : "Canadian French","fi_FI" : "Finnish"},"rtl":{}},"verLang":5} |
6. Check Version Command
Info |
---|
Command name: ver |
Note |
---|
By default, the output format for ver command is a simple HTML page. |
Example 6.1: Check Application Version
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name/spellcheck/script/ssrv.fcgi:2880/?cmd=ver |
Code Block | ||||
---|---|---|---|---|
| ||||
<html> <style> * { font-family:"Verdana,Helvetica";font-size:10px}</style> <body bgcolor=white> <body> <center> <table border=1> <tr> <td colspan=2> <center> <b>(c) 2000-2017 WebSpellChecker LLC <br>All rights reserved. <br>www.webspellchecker.net </b> </center> </td> </tr> <tr> <td><b>Program name:</b></td> <td>ssrv</td> </tr> <tr> <td> <b>Program version:</b> </td> <td>4.9.5 x64 master:f7f1a0d (452) #62 for Linux</td> </tr> <tr> <td colspan=2></td> </tr> </table> </center> </body> </html> |
7. Check Engines Status Command
Info |
---|
Command name: status |
Note |
---|
By default, the output format for status command is a simple text page. |
Example 7.1: Check Engines Status
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name/spellcheck/script/ssrv.fcgi:2880/?cmd=status |
Code Block | ||||
---|---|---|---|---|
| ||||
Spell Check Engine is ACTIVE Grammar Engine is NOT ACTIVE Thesaurus Engine is ACTIVE Please find below the description of the statuses that are received from SSRV component below: 'ACTIVE' status means that an Engine works properly. 'NOT ACTIVE' status means that an Engine is not enabled or does not work properly. Also 'NOT ACTIVE' status appears for the Grammar-check Engine in case with the installation under the Linux-based environments. For more details and assistance, please contact the technical support team at [email protected]. |
...