WebSpellChecker Web API provides a set of spell and grammar checking commands and additional parameters to the WebSpellChecker engine.
Supported requests methods:
- GET
- POST
Supported output types:
- XML
- JSON
1. Web API Commands Overview
Parameter | Commands | |
---|---|---|
cmd |
| The command sets specific parameters and values for spell checking of a given piece of text. |
| The command defines parameters for grammar checking of a given piece of text. | |
| The command defines actions that will be performed with a user dictionary. |
http(s)://svc.webspellchecker.net/spellcheck3/script/ssrv.fcgi?cmd=[command]&[parameter]=[value]&customerid=[encrypted_customer_ID]
2. Check Spelling Command
Command name: check_spelling
Here is a list of all possible parameters and values that can be used with the check_spelling command.
# | Parameter | Possible Values | Default Value | Description |
---|---|---|---|---|
1 | format |
| xml | 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 | out_type |
| words | The parameter defines a type of data output whether return misspelled words positions in the provided text or exact words. |
4 | ignore_all_caps |
| 0 | The parameter regulates whether to ignore capitalized words or not. |
5 | ignore_words_with_numbers |
| 0 | The parameter regulates whether to ignore words containing numbers or not. |
6 | ignore_mixed_case |
| 0 | The parameter regulates whether to ignore words written with mixed case letters or not. |
7 | ignore_domain_names |
| 0 | The parameter regulates whether to ignore domain names, web addresses or not. |
8 | text |
| The parameter defines a text which will be sent for check spelling. 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. | |
9 | slang |
| en_US | The parameter sets a shot code of a language which will be used for check spelling. |
10 | user_dictionary |
| The parameter specifies a user dictionary name which will be used during check spelling. | |
11 | custom_dictionary |
| This parameter specifies a custom dictionary which will be used for check spelling. | |
12 | user_wordlist |
| The parameter provides the list of additional coma-separated words which will be used for spellchecking. | |
13 | version | 1.0 | 1.0 | The parameter indicates the version of Web API. |
14 | customerid |
| This parameter specifies a special customer ID value that has to be passed to a request query. An encrypted customer ID can be obtained upon subscription to the Cloud WebSpellChecker services (paid or trial). Without a valid encrypted customer ID, any request to Cloud WebSpellChecker Web API will fail. |
Example 1.1: Check Spelling Request (XML)
http(s)://svc.webspellchecker.net/spellcheck3/script/ssrv.fcgi?cmd=check_spelling&format=xml&text=This sampl text demonstrates the work of the WebSpellChecker Web API service.&out_type=words&slang=en_US&customerid=[encrypted_customer_ID]
Parameters:
- Command: check_spelling
- Format: XML
- Text: “This sampl text demonstrates the work of the WebSpellChecker Web API service.”
- Output: words
- Language: American English (en_US)
Request Response:
<?xml version="1.0" encoding="utf-8"?> <check_spelling> <misspelling> <word>sampl</word> <ud>false</ud> <suggestions> <suggestion>sample</suggestion> <suggestion>sampled</suggestion> <suggestion>sampler</suggestion> <suggestion>samples</suggestion> <suggestion>ample</suggestion> <suggestion>amply</suggestion> <suggestion>scamp</suggestion> <suggestion>stamp</suggestion> </suggestions> </misspelling> </check_spelling>
Example 1.2: Check Spelling Request (JSON)
http(s)://svc.webspellchecker.net/spellcheck3/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&customerid=[encrypted_customer_ID]
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:
[{"word":"sampl","ud":"false","suggestions":["sample","sampled","sampler","samples","ample","amply","scamp","stamp"]}]
2. Grammar Check Command
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 |
| xml | 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. The grammar checking feature is available for American English and British English. |
Example 2.1: Grammar Check Request (XML)
http(s)://svc.webspellchecker.net/spellcheck3/script/ssrv.fcgi?cmd=grammar_check&format=xml&text=Web API provides a gramar checking command that will help you builds a custom solution.&slang=en_US&customerid=[encrypted_customer_ID]
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:
<?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 2.2: Grammar Check Request (JSON)
http(s)://svc.webspellchecker.net/spellcheck3/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&customerid=[encrypted_customer_ID]
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:
[{"phrase":"you builds","description":"Pronoun \"you\" conflicts with verb \"builds.\"","problem_id":"437780848", "suggestions":["you build","you, builds"]}]
3. User Dictionary Command
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 |
| xml | 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 | 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 remanes 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. The getdict action is available only for the JSON format. |
6 | addword | name |
| The action adds a new word to a specified user dictionary. |
word |
| |||
7 | deleteword | name |
| The action removes a word from a specified user dictionary. |
word |
| |||
8 | editword | name |
| The action replaces a word in a specified user dictionary with a new one. |
word |
| |||
new_word |
|
Example 3.1: Create User Dictionary (XML)
http(s)://svc.webspellchecker.net/spellcheck3/script/ssrv.fcgi?cmd=user_dictionary&format=xml&action=create&name=user_dictionary&wordlist=SCAYT,SpellCheckAsYouType,WSC,WebSpellChecker,Proofreader&customerid=[encrypted_customer_ID]
Parameters:
- Command: user_dictionary
- Action: Create
- Name: “user_dictionary”
- Wordlist: “SCAYT, SpellCheckAsYouType, WSC, WebSpellChecker, Proofreader”
- Format: XML
Request Response:
<?xml version="1.0" encoding="utf-8"?> <dictionary> <name>user_dictionary</name> <action>create</action> </dictionary>
Example 3.2: Get User Dictionary Content (JSON)
http(s)://svc.webspellchecker.net/spellcheck3/script/ssrv.fcgi?cmd=user_dictionary&format=json&action=getdict&name=user_dictionary&customerid=[encrypted_customer_ID]
Parameters:
- Command: user_dictionary
- Action: getdict
- Name: “user_dictionary”
- Format: JSON
Request Response:
{"name":"user_dictionary","action":"getdict","wordlist":["SCAYT"," SpellCheckAsYouType"," WSC"," WebSpellChecker"," Proofreader"]}