You need to have (or sign-up for) a developer account (it's free)

Login, and click 'myWebServices' tab on the top bar menu

Now you can register a new application. On the right side, find the 'Register a new Application' box, and click on 'Spell Checker'

Fill the form, choose between a free subscription, on-demand or paid subscription, and click Save

Now you have activated the spell checking web service for your new application.

In 'Your Active Web Service list' click on the application name to have access to subscription details, including the PublicAccessID and the SecretAuthKey

Replace the PublicAccessID and SecretAuthKey in the code snippet below with yours data, and you are ready in less than 1 minute!

The PublicAccessID key is sent as clear text, and is used to identify both user and application. Our platform uses an hash based verification system to check the data integrity and the user identity.

The SecretAuthKey is only used locally to generate the hash, and it's never transmitted over the network. You never have to send it. Keep it secret!

API Documentation

Parameter	Description
rService	Requested service. (txp=Text Processing) Value = 'txp'
rType	Requested service type. (spc=Spell Checker) Value = 'spc'
authWSControlKey	The authWSControlKey is an hash key calculated on the submitted data. It is used to verify authorization to use the web service and to verify data integrity.
publicAccessID	The PublicAccessID key is used to identify both user and application. The platform uses an hash based verification system to check the data integrity and the user identity.
pText	A word or a sentence to analyze, depending on the requested service (pTest). If the requested service is 'bestmatch-word' (bmw) or 'n-bestmatch-word' (nbw), the pText is a word. If pTest is 'bestmatch-string', then pText is a string containing a sentence or a set of words. Example: pText = 'throug'
pLang	The language of the input text. English and Italian are supported. Values: 'en' = English 'it' = Italian
pTest	Spell Checking Type bestmatch-word (bmw): Returns the word with the best match respect to pText (pText must be a word). bestmatch-strings (bms): Returns the best correction to the string. It can correct multiple errors simultaneously. (pText must be a string representing a sentence or a set of words.). n-bestmatch-word (nbw): Returns the n-best words candidates as possible correction of the word in input, ordered by ranking. (pText in this case is represented by a single word) Values: 'bmw' = bestmatch-word 'bms' = bestmatch-strings 'nbw' = n-bestmatch-word

Quick Start - Code Snippets

Java Code Snippet - Spell Checking

PHP Code Snippet - Spell Checking

Examples

Best Match on a word

Input:

rService = "txp"
rType = "spc"
pText = "throug"
pTest = "bmw"
pLang = "en"

Output:

                        				<?xml version="1.0" encoding="UTF-8"?>
                        				<response>
                        					<results>
                        						<bmw>through</bmw>
                        					</results>
                        				</response>
                        

Best Match on a Sentence

Input:

rService = "txp"
rType = "spc"
pText = "Stavo andado a casa, poi ho pensato di pasare al bar."
pTest = "bms"
pLang = "it"

Output:

                        				<?xml version="1.0" encoding="UTF-8"?>
                        				<response>
                        					<results>
                        						<bms>Stavo andando a casa, poi ho pensato di passare al bar.</bms>
                        					</results>
                        				</response>
                        

n-bestmatch word

Input:

rService = "txp"
rType = "spc"
pText = "throu"
pTest = "nbw"
pLang = "en"

Output:

                        				<?xml version="1.0" encoding="UTF-8"?>
                        				<response>
                        					<results>
                        						<nbw><rank>1</rank><word>throe</word></nbw>
                        						<nbw><rank>2</rank><word>throw</word></nbw>
                        						<nbw><rank>3</rank><word>through</word></nbw>
                        						<nbw><rank>4</rank><word>thou</word></nbw>
                        						<nbw><rank>5</rank><word>theory</word></nbw>
                        						<nbw><rank>6</rank><word>throb</word></nbw>
                        						<nbw><rank>7</rank><word>three</word></nbw>
                        						<nbw><rank>8</rank><word>threw</word></nbw>
                        						<nbw><rank>9</rank><word>thor</word></nbw>
                        						<nbw><rank>10</rank><word>thorough</word></nbw>
                        						<nbw><rank>11</rank><word>theo</word></nbw>
                        						<nbw><rank>12</rank><word>thoreau</word></nbw>
                        						<nbw><rank>13</rank><word>thrum</word></nbw>
                        						<nbw><rank>14</rank><word>thous</word></nbw>
                        						<nbw><rank>15</rank><word>thu</word></nbw>
                        						<nbw><rank>16</rank><word>there</word></nbw>
                        						<nbw><rank>17</rank><word>tho</word></nbw>
                        						<nbw><rank>18</rank><word>thorn</word></nbw>
                        						<nbw><rank>19</rank><word>thorn</word></nbw>
                        						<nbw><rank>20</rank><word>theron</word></nbw>
                        						<nbw><rank>21</rank><word>throat</word></nbw>
                        						<nbw><rank>22</rank><word>throed</word></nbw>
                        						<nbw><rank>23</rank><word>throes</word></nbw>
                        						<nbw><rank>24</rank><word>throne</word></nbw>
                        						<nbw><rank>25</rank><word>thrown</word></nbw>
                        						<nbw><rank>26</rank><word>throws</word></nbw>
                        						<nbw><rank>27</rank><word>thor's</word></nbw>
                        						<nbw><rank>28</rank><word>throe's</word></nbw>
                        					</results>
                        				</response>