LinguLab API Architecture

API provides following main blocks:

Authentication block: allows to authenticate user and provides credentials (Login web-method).
GetUserData returns information about authenticated user;
Validation block: allows to check authentication key (ValidateAuthentication web-method)
Processing Languages block: allows to get existing languages for processing (GetLanguages web-method);
Configuration block: allows to get existing configurations of modules (GetConfigurations web-method);
LinguLab API Endpoint: provides access to LinguLab measure system (ProcessText web-method or ProcessTextAdv web-method);
Text analysis result block: provides functionality of getting latest version of processed text and analysis result (GetResult or GetResultAdv).
Module items block: provides functionality of getting module items for highlighting of processed text (GetModuleItems web-method or GetKeywordItems web-method).
Ignore (word list) management block: allows adding a word to word list for current user/team (AddToIgnore web-method).
Module help block: returns help data for module (GetHelp or GetWcag).

Try LinguLab API

Try LinguLab API with minimum parameters in fast way:

Use Login method with username and password parameters. Get authentication key from returned result.
Call ProcessText method with "Text" (HTML value) property of inputData parameter and specify authentication key as second parameter. Get analysis result panel HTML from "MeasureStarsHtml" property of returned result.
Output analysis result panel HTML to your website.

Note: in case "ConfigurationId" and "LanguageKey" properties does not set for inputData parameter of ProcessText method default value will be used for analysis.

Important web.config setting (.NET Client)

Please note that Visual Studio generates (when API reference is added) default binding with small returned content string length value. Some API methods return result bigger than default binding value. In this case method call will throw an exception. Please use following binding setting in web.config file (configuration/system.serviceModel/bindings/basicHttpBinding section) with extended "maxStringContentLength" value:

</security>

</binding>

LinguLab API Architecture

Authentication

Light Integration

Full Integration

Try LinguLab API

Important web.config setting (.NET Client)