You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 58 Next »

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

Supported requests methods:

  • GET
  • POST

Supported output types:

  • XML
  • JSON (Default)

Request specification:

  • 50,000 characters per check

Overview

Below is the whole list of commands “cmd” that are available in WebSpellChecker API:

ParameterCommandsDescription
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. 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_languageDetect the language of given text.  Refer to Detect language command for details.
get_infoGet information about the subscription. Refer to Get info command for details.

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

Request URL (GET): 
https://svc.webspellchecker.net/api?cmd=[command]&[parameter]=[value]&customerid=[your-service-id]

Template of request URL using POST

Request URL (POST): 
https://svc.webspellchecker.net/api?
Body (Raw): 
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.