1. Overview
There are tree main commands that are available for Web API requests:
Parameter | Commands | Description |
---|---|---|
cmd | check | RECOMMENDED Global check command that checks text for all enabled types of errors (spelling, grammar, etc.) and its parameters. Check more in Check сommand. |
check_spelling | Check spelling command and its parameters. | |
grammar_check | Grammar check command and its parameters. | |
user_dictionary | User dictionary command and actions that can be performed with user dictionaries. | |
detect_language | Detect the language of given text. Refer to Detect language command for details. |
1.1. Request format
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.
Template of request URL using GET
https://svc.webspellchecker.net/api/?cmd=[command]&[parameter]=[value]&customerid=[your-service-id]
Template of request URL using POST
https://svc.webspellchecker.net/api/?
cmd=[command]&[parameter]=[value]&customerid=[your-service-id]
1.2. Response format
The response format will differ depending on the type of command. You can find examples of responses for each command below.
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 |
| json | The response format for output data. |
2 | callback |
| 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 | A type of data output specifying the way to return misspelled words positions in the provided text or exact words. |
4 | ignore_all_caps |
| 0 | Ignore capitalized words. |
5 | ignore_words_with_numbers |
| 0 | Ignore words containing numbers. |
6 | ignore_mixed_case |
| 0 | Ignore words written with mixed case letters. |
7 | ignore_domain_names |
| 0 | Ignore domain names, web addresses. |
8 | text |
| A piece of text which will be sent for check. 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. Avoid using # and & symbols in the text. | |
9 | slang |
| en_US | A short code of a language which will be used for spell checking. |
10 | user_dictionary |
| A user dictionary name which will be used during spell checking. | |
11 | user_wordlist |
| The list of additional comma-separated words which will be used for spell checking. | |
12 | custom_dictionary |
| ||
13 | version | 1.0 | 1.0 | The version of Web API. |
14 | customerid |
| A special service ID value (activation key) that has to be passed to a request query. It's obtained upon subscription to the Cloud services (paid or trial). Applicable only for the Cloud version. |
Example 2.1 [GET]: Check spelling request (Output in XML)
https://svc.webspellchecker.net/api/?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=[your-service-id]
Parameters:
- Command: check_spelling
- Format: xml
- Text: This sampl text demonstrates the work of the WebSpellChecker Web API service.
- Output: words
- Language: 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 2.2 [GET]: Check spelling request (Output in JSON)
https://svc.webspellchecker.net/api/?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=[your-service-id]
Parameters:
- Command: check_spelling
- Format: json
- Text: This sampl text demonstrates the work of the WebSpellChecker Web API service.
- Output: words
- Language: en_US
Request response:
[ { "word": "sampl", "ud": false, "suggestions": [ "sample", "sampled", "sampler", "samples", "ample", "amply", "scamp", "stamp" ] } ]
Example 2.3 [POST]: Check spelling request (Output in JSON)
Here we use the same request and parameters as described in example above but form it as a POST request.
https://svc.webspellchecker.net/api/?
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=[your-service-id]
Request response:
[ { "word": "sampl", "ud": false, "suggestions": [ "sample", "sampled", "sampler", "samples", "ample", "amply", "scamp", "stamp" ] } ]
3. 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 |
| json | The response format for the output data. |
2 | callback |
| 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 |
| A piece of text which will be sent for check. 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 | A short code of a language which will be used for grammar checking. The grammar checking option is available for specific list of languages that are marked with the green color: Supported languages |
Example 3.1 [GET]: Grammar check request (Output in XML)
https://svc.webspellchecker.net/api/?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=[your-service-id]
Parameters:
- Command: grammar_check
- Format: xml
- Text: web API provides a gramar checking command that will help you builds a custom solution.
- Language: en_US
Request response:
<grammar_check> <grammar_problem> <sentence>web API provides a gramar checking command that will help you builds a custom solution</sentence> <matches> <match> <message>This sentence does not start with an uppercase letter</message> <offset>0</offset> <length>3</length> <rule> <id>UPPERCASE_SENTENCE_START</id> </rule> <suggestions> <suggestion>Web</suggestion> </suggestions> </match> </matches> </grammar_problem> </grammar_check>
Example 3.2 [GET]: Grammar check request (Output in JSON)
https://svc.webspellchecker.net/api/?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=[your-service-id]
Parameters:
- Command: grammar_check
- Format: json
- Text: web API provides a gramar checking command that will help you builds a custom solution.
- Language: en_US
Request response:
[ { "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" ] } ] } ]
Example 3.3 [POST]: Grammar check request (Output in JSON)
Here we use the same request and parameters as described in example above but form it as a POST request.
https://svc.webspellchecker.net/api/?
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=[your-service-id]
Request response:
[ { "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
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 response format for output data. |
2 | callback |
| 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 |
| 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 |
| Create a new user dictionary. |
wordlist |
| |||
2 | delete | name |
| Delete a selected user dictionary. |
3 | rename | name |
| Rename a specified dictionary and sets a new name. |
new_name |
| |||
4 | check | name |
| Check if a specified user dictionary exists on the server. |
5 | getdict | name |
| Request content of a specified user dictionary. The getdict action is available only for the JSON format. |
6 | addword | name |
| Add 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 |
| Remove a word from a specified user dictionary. |
word |
| |||
8 | editword | name |
| Replace a word in a specified user dictionary with a new one. |
word |
| |||
new_word |
|
Example 4.1 [GET]: Create user dictionary (Output in XML)
https://svc.webspellchecker.net/api/?cmd=user_dictionary&format=xml&action=create&name=user_dictionary&wordlist=SCAYT,SpellCheckAsYouType,WSC,WebSpellChecker,WProofreader&customerid=[your-service-id]
Parameters:
- Command: user_dictionary
- Action: create
- Name: user_dictionary
- Wordlist: SCAYT, SpellCheckAsYouType, WSC, WebSpellChecker, WProofreader
- Format: XML
Request response:
<user_dictionary> <name>user_dictionary</name> <action>create</action> <wordlist> <word>SCAYT</word> <word>SpellCheckAsYouType</word> <word>WSC</word> <word>WebSpellChecker</word> <word>WProofreader</word> </wordlist> <modificationTime>1571762101</modificationTime> </user_dictionary>
Example 4.2 [GET]: Get user dictionary content (Output in JSON)
https://svc.webspellchecker.net/api/?cmd=user_dictionary&format=json&action=getdict&name=user_dictionary&customerid=[your-service-id]
Parameters:
- Command: user_dictionary
- Action: getdict
- Name: user_dictionary
- Format: json
Request response:
{ "name": "user_dictionary", "action": "getdict", "wordlist": [ "SCAYT", "SpellCheckAsYouType", "WSC", "WebSpellChecker", "WProofreader" ], "modificationTime": 1571762101 }
The GET request size is 2048 symbols.
Example 4.3 [POST]: Get user dictionary content (Output in JSON)
Using the same request and parameters as described in example 4.2 but form it as a POST request.
https://svc.webspellchecker.net/api/?
cmd=user_dictionary&format=json&action=getdict&name=user_dictionary&customerid=[your-service-id]
Request response:
{ "name": "user_dictionary", "action": "getdict", "wordlist": [ "SCAYT", "SpellCheckAsYouType", "WSC", "WebSpellChecker", "WProofreader" ], "modificationTime": 1571762101 }
5. HTTP status codes
Refer to Overview of HTTP Status Codes section for more information on HTTP responses you may get when integrating WebSpellChecker and testing REST API.