Page History
Excerpt Include IN:_include_webapi_intro IN:_include_webapi_intro nopanel true
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
Table of Contents | ||
---|---|---|
|
WebSpellChecker Web API provides a set of spell and grammar checking commands and additional parameters to the WebSpellChecker engine.
Tip |
---|
Supported requests methods:
Supported output types:
|
1. Web API Commands Overview
...
- check_spelling
...
- grammar_check
...
- user_dictionary
...
Code Block | ||
---|---|---|
| ||
http(s)://svc.webspellchecker.net/spellcheck3/script/ssrv.fcgi?cmd=[command]&[parameter]=[value]&customerid=[encrypted_customer_ID] |
2. Check Spelling Command
Info |
---|
Command name: check_spelling |
Here is a list of all possible parameters and values that can be used with the check_spelling command.
...
- json
- xml
...
- callback function name
...
- positions – Return positions and length of misspelled words in a given text and their suggestions.
- words – Return misspelled words and their suggestions.
...
- 0 – Do not ignore all words written in capital letters (e.g. UPPERCASE).
- 1 – Ignore all words written in capital letters.
...
- 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
...
- Default languages short codes (e.g. en_US)
- Additional languages short codes (e.g. ar_SA)
...
- user dictionary name (e.g. testdict)
...
- additional wordlist
...
- encrypted_customer_ID value
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).
Warning |
---|
Without a valid encrypted customer ID, any request to Cloud WebSpellChecker Web API will fail. |
Note |
---|
There is no separate parameter available in the Cloud version for custom dictionaries. If a new custom dictionary is added or existing dictionary is modified, the information about this custom dictionary will be automatically decrypted in the encrypted custom ID string. As for now, it means that any manipulations with the custom dictionaries functionality require regeneration of encrypted custom ID string. |
Example 2.1: Check Spelling Request (XML)
Code Block | ||
---|---|---|
| ||
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:
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: Check Spelling Request (JSON)
Code Block | ||
---|---|---|
| ||
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:
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
...
- en_US – American English short code
- en_GB – British English short code
...
The parameter sets a shot code of a language which will be used for grammar checking.
Note |
---|
The grammar checking feature is available for American English and British English. |
Example 3.1: Grammar Check Request (XML)
Code Block | ||
---|---|---|
| ||
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:
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 Request (JSON)
Code Block | ||
---|---|---|
| ||
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:
Code Block | ||||
---|---|---|---|---|
| ||||
[{"phrase":"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
...
- 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
...
- coma-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: Create User Dictionary (XML)
Code Block | ||
---|---|---|
| ||
http(s)https://svc.webspellchecker.net/spellcheck3/script/ssrv.fcgiapi?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:
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)
[command]&[parameter]=[value]&customerid=[your-service-id] |
Template of request URL using POST
Code Block | ||
---|---|---|
Code Block | ||
| ||
http(s)https://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:
...
language | js |
---|---|
theme | Emacs |
...
api? |
Code Block | ||
---|---|---|
| ||
cmd=[command]&[parameter]=[value]&customerid=[your-service-id] |
Response format
The response format will differ depending on the type of command.
HTTP status codes
Refer to Overview of HTTP Status Codes section for more information on HTTP responses you may get when integrating WebSpellChecker API.