Page History
Excerpt Include IN:_include_webapi_intro IN:_include_webapi_intro nopanel true
Panel | ||||
---|---|---|---|---|
|
1. Overview
Getting started
You need to have an active subscription to use WebSpellChecker API. If you don't have one yet, you can sign up for a trial version first to evaluate if it fits your needs. On the subscription, you will receive a confirmation email with the subscription information and service ID (an activation key). You can also find your service ID on your account page on the webspellchecker.com website.
Overview
Below is the whole list of commands “cmd” that are available in WebSpellChecker API
...
:
Parameter | Commands | Description |
---|---|---|
cmd | check |
...
* | ||||||||
check_spelling | Check spelling command and its parameters. Refer to Check spelling command. | |||||||
grammar_check | Grammar check command and its parameters. Refer to Grammar check command for details. | |||||||
user_dictionary | User dictionary command and actions that can be |
...
performed with user dictionaries. Refer to User dictionary command for details. | |
detect_language | Detect the language of given text. |
...
Refer to Detect language command for details. | |
get_info | Get information about the subscription. Refer to Get info command for details. |
Note |
---|
Check сommand combines all available check types and is a replacement for older Check spelling command and Grammar check command. |
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
Code Block | ||
---|---|---|
|
...
https://svc.webspellchecker.net/ |
...
api?cmd=[command]&[parameter]=[value]&customerid=[your-service-id] |
Template of
...
request URL using POST
Code Block | ||
---|---|---|
|
...
https://svc.webspellchecker.net/ |
...
api? |
Code Block | ||
---|---|---|
| ||
cmd=[command]&[parameter]=[value]&customerid=[your-service-id] |
...
Response
...
format
The response format will differ depending on the type
...
2. Check Spelling Command
Info |
---|
Command name: check_spelling |
...
of
...
command
...
- json
- xml
...
- callback function name
...
.
...
...
- 0 – Do not ignore words that contain numbers (e.g. Number1).
- 1 – Ignore words that contain numbers.
...
- 0 – Do not ignore words with mixed case letters (e.g. MixedCase).
- 1 – Ignore words with mixed case letters.
...
- 0 – Do not ignore web addresses that start with either “www”, “http:” or “https:” and end with a domain name.
- 1 – Ignore web addresses and domain names.
...
- plain 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.
Note |
---|
Avoid using # and & symbols in the text. |
...
- Default Languages List (e.g. en_US)
- Additional Languages List (e.g. ca_ES)
...
- user dictionary name (e.g. testdict)
...
- additional wordlist
...
- custom dictionary IDs (e.g. 100694)
Global custom dictionary ID(s) which can be used during spell checking.
Info |
---|
Each new Dictionary on the creation obtains its unique Dictionary ID. Depending on the type of the version of product you are using, refer to Cloud or Server guides respectively. |
...
- your-service-id value
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).
Warning |
---|
Applicable only for the Cloud version. |
Example 2.1 [GET]: Check Spelling Request (Output in XML)
Code Block | ||
---|---|---|
| ||
http(s)://svc.webspellchecker.net/spellcheck31/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=[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:
Code Block | ||||
---|---|---|---|---|
| ||||
<?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)
Code Block | ||
---|---|---|
| ||
http(s)://svc.webspellchecker.net/spellcheck31/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=[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:
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"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.
Code Block | ||
---|---|---|
| ||
https://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi? |
Code Block | ||
---|---|---|
| ||
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:
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"word": "sampl",
"ud": false,
"suggestions": [
"sample",
"sampled",
"sampler",
"samples",
"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.
...
- json
- xml
...
- callback function name
...
- plain text
...
- Default Languages List (e.g. en_US)
- Additional Languages List (e.g. ca_ES)
...
A short code of a language which will be used for grammar checking.
Note |
---|
The grammar checking option is available for specific list of languages that are marked with the green color: |
Example 3.1 [GET]: Grammar Check Request (Output in XML)
Code Block | ||
---|---|---|
| ||
http(s)://svc.webspellchecker.net/spellcheck31/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=[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:
Code Block | ||||
---|---|---|---|---|
| ||||
<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)
Code Block | ||
---|---|---|
| ||
http(s)://svc.webspellchecker.net/spellcheck31/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=[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:
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"
]
}
]
}
] |
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.
Code Block | ||
---|---|---|
| ||
http(s)://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi? |
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&customerid=[your-service-id] |
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.
...
- json
- xml
...
- 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.
...
- name of a new user dictionary
...
- comma-separated words which will be added to a new dictionary
...
- name of a selected user dictionary
...
- name of a selected user dictionary
...
- a new name for a chosen user dictionary
...
- name of a chosen user dictionary
...
- name of a required user dictionary
...
- 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 [GET]: Create User Dictionary (Output in XML)
Code Block | ||
---|---|---|
| ||
http(s)://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?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:
Code Block | ||||
---|---|---|---|---|
| ||||
<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)
Code Block | ||
---|---|---|
| ||
http(s)://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?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:
Code Block | ||||
---|---|---|---|---|
| ||||
{
"name": "user_dictionary",
"action": "getdict",
"wordlist": [
"SCAYT",
"SpellCheckAsYouType",
"WSC",
"WebSpellChecker",
"WProofreader"
],
"modificationTime": 1571762101
} |
Info |
---|
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.
Code Block | ||
---|---|---|
| ||
http(s)://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi? |
Code Block | ||
---|---|---|
| ||
cmd=user_dictionary&format=json&action=getdict&name=user_dictionary&customerid=[your-service-id] |
Request Response:
Code Block | ||||
---|---|---|---|---|
| ||||
{
"name": "user_dictionary",
"action": "getdict",
"wordlist": [
"SCAYT",
"SpellCheckAsYouType",
"WSC",
"WebSpellChecker",
"WProofreader"
],
"modificationTime": 1571762101
} |
...
HTTP status codes
Refer to Overview of HTTP Status Codes section for more information on HTTP responses you may get when integrating WebSpellChecker
...
API.