Connector Design

This document is a language-agnostic summary of the connector api. The api has been written using an object-oriented approach to provide a consistent high-level component design across implementations. The main components are listed below:


APIService
This is the connector api's integration point with our api service and is responsible for request encoding, command execution and interpreting the response provided by our servers. It has methods for executing both 'Internal/Reseller' and 'OpenApp' requests, both of which return 'Response' instances.

See more details.
Response
This is an object representation of the response from the server. Each command has a different set of response data but this is a essentially an aggregate of 'DataTable' instances. It also contains a set of loosely-typed 'global vars' which again vary by command.

See more details.
DataTable
This contains the actual rows of data that resulted from the command's execution. It also contains a set of loosely-typed 'parameters', much like the 'Response'.

See more details.

For more information about access to the Majestic API suite, visit our Plans & Pricing page.