Breadcrumbs

Page History

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

Comment: Multiple text edits to improve readability and style and conform to other commands descriptions patterns.

WebSpellChecker Web API provides a set of spell and grammar checking commands and additional parameters to the WebSpellChecker engine.

Tip
Supported requests methods: GET POST Supported output types: XML JSON (Default)

Tip

Supported requests methods:

GET
POST

Supported output types:

XML
JSON (Default)

Panel

Table of Contents

style	none

1. Overview

There are tree main commands that are available for Web API requests:

Parameter	Commands	Description
cmd	check	Global check command that checks text for all enabled types of errors (spelling, grammar, etc.) and its parameters.
	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.

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

Code Block

title	Request URL (GET):

http(s)://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?cmd=[command]&[parameter]=[value]&customerid=[encrypted_customer_ID]

Template of Request URL using POST

Code Block

title	Request URL (POST):

http(s)://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?

Code Block

title	Body (Raw):

cmd=[command]&[parameter]=[value]&customerid=[encrypted_customer_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

Info
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

format

json
xml

json

The parameter set a response format for output data.

callback

callback function name

The parameter specifies a 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”.

out_type

positions – Return positions and length of misspelled words in a given text and their suggestions.
words – Return misspelled words and their suggestions.

words

The parameter defines a A type of data output whether specifying the way to return misspelled words positions in the provided text or exact words.

ignore_all_caps

0 – Do not ignore all words written in capital letters (e.g. UPPERCASE).
1 – Ignore all words written in capital letters.

The parameter regulates whether to ignore Ignore capitalized words or not.

ignore_words_with_numbers

0 – Do not ignore words that contain numbers (e.g. Number1).
1 – Ignore words that contain numbers.

The parameter regulates whether to ignore Ignore words containing numbers or not.

ignore_mixed_case

0 – Do not ignore words with mixed case letters (e.g. MixedCase).
1 – Ignore words with mixed case letters.

The parameter regulates whether to ignore Ignore words written with mixed case letters or not.

ignore_domain_names

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.

The parameter regulates whether to ignore Ignore domain names, web addresses or not.

text

plain text

The parameter defines a

A piece of text which will be sent for check

spelling

The

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, that you shouldn't use

Note
Avoid using # and & symbols in the text.

slang

- Default Languages List (e.g. en_US)
- Additional Languages List (e.g. uk_UA)

en_US

The parameter sets a shot A short code of a language which will be used for check spellingspell checking.

user_dictionary

user dictionary name (e.g. testdict)

The parameter specifies a A user dictionary name which will be used during check spellingspell checking.

user_wordlist

additional wordlist

The parameter provides the list of additional comaadditional comma-separated words which will be used for spellcheckingspelling check.

custom_dictionary

custom dictionary IDs (e.g. 100694)

The parameter specifies global Global custom dictionary IDs ID(s) which can be used during check spellingspell checking.

Info
Each new Dictionary on the creation obtains its unique Dictionary ID. You can find information about your custom dictionaries by to you account panel on webspellchecker.net website (Login –> Dictionaries –> List of Custom Dictionaries) Depending on the type of the version of product you are using, refer to Cloud or Server guides respectively.

version

1.0

The parameter indicates the version of Web API.

customerid

encrypted_customer_ID value

This parameter specifies a A special customer ID value (activation key) that has to be passed to a request query.An encrypted customer ID can be It's 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 failApplicable only for the Cloud version.

Example 2.1 [GET]: Check Spelling Request (Output in XML)

Code Block

title	Request URL (GET):

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=[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: en_US

Request Response:

Code Block

language	xml
theme	Emacs

<?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

title	Request URL (GET):

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=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: en_US

Request Response:

Code Block

language	js
theme	Emacs

[
    {
        "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

title	Request URL (GET):

https://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?

Code Block

title	Body (Raw):

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]

Request Response:

Code Block

language	js
theme	Emacs

[
   {
       "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.

Parameter

Possible Values

Default Value

Description

format

json
xml

json

The parameter set a response format for the output data.

callback

callback function name

text

plain text

The parameter defines a A piece of text which will be sent for grammar checkingcheck. 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.

slang

Default Languages List (e.g. en_US)
Additional Languages List (e.g. uk_UA)

en_US

The parameter sets a shot 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

title	Request URL (GET):

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=[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: en_US

Request Response:

Code Block

language	xml
theme	Emacs

<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

title	Request URL (GET):

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=[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: en_US

Request Response:

Code Block

language	js
theme	Emacs

[
    {
        "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

title	Request URL (POST):

http(s)://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?

Code Block

title	Body (Raw):

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]

Request Response:

Code Block

language	js
theme	Emacs

[
    {
        "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 xml	json	The parameter set a response format for output data.
2	callback	callback function name		The parameter specifies a 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	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).		The parameter defines an 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	name of a new user dictionary	The action that creates Creates a new user dictionary.
1	create	wordlist	coma-separated words which will be added to a new dictionary	The action that creates Creates a new user dictionary.
2	delete	name	name of a selected user dictionary	The action that deletes Deletes a selected user dictionary.
3	rename	name	name of a selected user dictionary	The action that renames Renames a specified dictionary and sets a new name.
3	rename	new_name	a new name for a chosen user dictionary
4	check	name	name of a chosen user dictionary	The action that checks Checks if a specified user dictionary exists on the server.
5	getdict	name	name of a required user dictionary	The action requests content Requests content of a specified user dictionary. The getdict action is available only for the JSON format.
6	addword	name	name of a chosen user dictionary	The action adds 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.
6		word	a new word which will be added to a specified user dictionary
7	deleteword	name	name of a chosen user dictionary	The action removes Removes a word from a specified user dictionary.
7		word	word which will be removed from a specified user dictionary
8	editword	name	name of a chosen user dictionary	The action replaces Replaces a word in a specified user dictionary with a new one.
		word	word which will be edited
		new_word	a new word which replaces a word picked for editing

Example 4.1 [GET]: Create User Dictionary (Output in XML)

Code Block

title	Request URL (GET):

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=[encrypted_customer_ID]

Parameters:

Command: user_dictionary
Action: create
Name: user_dictionary
Wordlist: SCAYT, SpellCheckAsYouType, WSC, WebSpellChecker, WProofreader
Format: XML

Request Response:

Code Block

language	xml
theme	Emacs

<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

title	Request URL (GET):

http(s)://svc.webspellchecker.net/spellcheck31/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:

Code Block

language	js
theme	Emacs

{
    "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

title	Request URL (POST):

http(s)://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?

Code Block

title	Body (Raw):

cmd=user_dictionary&format=json&action=getdict&name=user_dictionary&customerid=[encrypted_customer_ID]

Request Response:

Code Block

language	js
theme	Emacs

{
    "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.

Content

Space Tools

Versions Compared

Old Version 41

New Version 42

Key

1. Overview

Template of Request URL using GET

Template of Request URL using POST

1.2. Response Format

Example 2.1 [GET]: Check Spelling Request (Output in XML)

Example 2.2 [GET]: Check Spelling Request (Output in JSON)

Example 2.3 [POST]: Check Spelling Request (Output in JSON)

3. Grammar Check Command

Example 3.1 [GET]: Grammar Check Request (Output in XML)

Example 3.2 [GET]: Grammar Check Request (Output in JSON)

Example 3.3 [POST]: Grammar Check Request (Output in JSON)

4. User Dictionary Command

Example 4.1 [GET]: Create User Dictionary (Output in XML)

Example 4.2 [GET]: Get User Dictionary Content (Output in JSON)

Example 4.3 [POST]: Get User Dictionary Content (Output in JSON)

5. HTTP Status Codes