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 'Markup Cleaner'

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

Now you have activated the NER 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=Markup Cleaner) Value = 'mkc'
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	Text that needs to be cleaned. Example: pText = '<br/>This is an example<br/>'
pType	Markup Cleaning Type plain: Returns the cleaned text as a whole. cluster: Returns the cleaned text as clusters. (pSens can be used to regulate the cluster sensibility). Values: 'plain' = Plain Cleaning 'cluster' = Cluster Cleaning
pSens	pSens regulates the cluster sensibility. Values: '0' = Min '15' = Max

Quick Start - Code Snippets

Java Code Snippet - Markup Cleaner

PHP Code Snippet - Markup Cleaner

Examples

Plain Cleaning

Input:

rService = "txp"
rType = "mkc"
pText = "The <br/><b>Artificial Intelligence</b> can be really useful in <a href="">Business Intelligence</a><br/> and in many other contexts<br/>"
pType = "plain"

Output:

                        				<?xml version="1.0" encoding="UTF-8"?>
                        				<response>
                        					<results>
                        						<text>
                        							The Artificial Intelligence  can be really useful in Business Intelligence
                        and in many other contexts
                        						</text>
                        					</results>
                        				</response>
                        			

Cluster Cleaning

Input:

rService = "txp"
rType = "mkc"
pText = "<br/>Text item 1<br/><br/><br/><p>Text item 2</p><div><br/><a href="#">and three</a></div>"
pTest = "cluster"
pSens = "1"

Output:

                        				<?xml version="1.0" encoding="UTF-8"?>
                        				<response>
                        					<results>
                        						<cluster>Text item 1</cluster>
                        						<cluster>Text item 2  and three</cluster>
                        					</results>
                        				</response>