GrammarSoft ApS

How to get started...

• Contact Eckhard Bick and discuss what you want to use the remote interface for, and pricing terms.
• Register with the site if you are not already registered.
• Let us know what your account is (the email address you used for registering) and how many access keys you want. You do not need a unique access key for every person using the remote interface, but as many unique keys as you want are available if you find it easier to manage. Only one person needs to register with us for each project, and that person will then be responsible for managing access keys for the project.

Techical Details

• Protocol is good ol' HTTP(S) to https://edu.visl.dk/tools/remoting/. You can use both GET and/or POST to send the variables required, and longer texts may only fit in POST.
• Authentication is via Challenge-Response.
• VISLSessionID is a 32-byte string of a-z0-9, and is the only common element that must be present in all but the first request.
• auth_key can be anything. If you want specific keys, let us know or we will generate 10-digit random keys for you.
• auth_password is the SHA1 sum of the SHA1 sum of the secret password and the auth_chap challenge. Expressed in pseudocode: SHA1(SHA1(secret password)+auth_chap)
• secret password you should never send in plain text anywhere. If you want specific passwords, let us know or we will generate 10-digit random passwords for you.
• auth_chap is a 40-byte string of a-z0-9, and is the challenge for the authentication attempt.
• lang is a VISL language code, e.g. da or es. Defaults to 'en'.
• mode is flat or tree. Defaults to 'tree'.
• text is plain text to be parsed. Please keep this in UTF-8 encoding and without markup. Known issue: The interface works best if you send one sentence per request. This limitation is being worked on.

Changes

• 2007-06-28: All input should now be in Unicode UTF-8 encoding. All output from the interface will likewise be in UTF-8 encoding.

Guidelines

• Do not reauthenticate for each piece of text you want to parse. You only need to authenticate if you receive a 403 Authentication Required error when trying to parse text.

Example successful authentication

• Example source in PHP
• Example source in Perl

GET /tools/remoting/?auth_key=examplekey HTTP/1.1
Host: edu.visl.dk

HTTP/1.1 200 OK
Set-Cookie: VISLSessionID=c12e285e1a85e5b4eaac4bc706bc0a0c; path=/
Content-Type: text/plain;charset=utf-8

VISLSessionID=c12e285e1a85e5b4eaac4bc706bc0a0c
auth_chap=641b506199856fd43a2ef8c50b90a60229709e36

GET /tools/remoting/?VISLSessionID=c12e285e1a85e5b4eaac4bc706bc0a0c
    &auth_password=641b506199856fd43a2ef8c50b90a60229709e36 HTTP/1.1
Host: edu.visl.dk

HTTP/1.1 200 OK
Set-Cookie: VISLSessionID=c12e285e1a85e5b4eaac4bc706bc0a0c; path=/
Content-Type: text/plain;charset=utf-8

VISLSessionID=c12e285e1a85e5b4eaac4bc706bc0a0c
auth_status=1

Example text parsing

GET /tools/remoting/?VISLSessionID=c12e285e1a85e5b4eaac4bc706bc0a0c
    &lang=en
    &text=this+is+a+little+test+of+the+remote+feature HTTP/1.1
Host: edu.visl.dk

HTTP/1.1 200 OK
Set-Cookie: VISLSessionID=c12e285e1a85e5b4eaac4bc706bc0a0c; path=/
Content-Type: text/plain;charset=utf-8

SOURCE: live
1. tekst
A1
STA:cl
S:pron('this' PRON INDP DEM SG) this
P:v('be' V PRES SG3 VFIN)       is
Cs:g
=D:pron('a_little' PRON DET POST SG)    a_little
=H:n('test' N NOM SG)   test
=D:g
==H:prp('of' PRP)       of
==D:g
===D:art('the' ART DET CENTRAL SG/PL)   the
===D:adj('remote' ADJ ABS)      remote
===H:n('feature' N NOM SG)      feature