Access2View API Documentation

Getting Access

This step will be slightly different depending on whether you're producing software for your own in-house agents, or you're building third-party software used by many client agents who may or may not use Access2View's services.

Internal Software

Contact us and we'll supply you with a permanent Access Token to the API for your account within Access2View.

Supply this Access Token on every request to the API as the Authorization header. For example if you're supplied the Access Token Bearer foobar728, supply the header: Authorization: Bearer foobar728.

Third-Party Software

We'll handle authentication using OAuth 2. Contact us and we'll supply you with a "Client ID" and "Client Secret". View our OAuth 2 documentation.. You'll receive a permanent Access Token to the API of the account you've connected.

Supply this Access Token on every request to the API as the Authorization header. For example if you're supplied the Access Token Bearer foobar728, supply the header: Authorization: Bearer foobar728.

JSON or XML?

For JSON, please supply your Content-Type and Accept headers as application/json.

For XML, please supply your Content-Type and Accept headers as application/xml.

Note that XML is auto-converted to/from JSON via an XML format known as JSONx. Sample:

{
    "name": "Dan",
    "points": 92,
    "colours": [
        "Red",
        "Blue"
    ],
    "active": true,
    "some_object_type": {
        "foo": "Bar",
        "yes": false
    }
}
<?xml version="1.0" encoding="UTF-8"?>
<json:object xmlns:json="http://www.ibm.com/xmlns/prod/2009/jsonx" xsi:schemaLocation="http://www.datapower.com/schemas/json jsonx.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <json:string name="name">Dan</json:string>
 <json:number name="points">92</json:number>
 <json:array name="colours">
  <json:string>Red</json:string>
  <json:string>Blue</json:string>
 </json:array>
 <json:boolean name="active">true</json:boolean>
 <json:object name="some_object_type">
  <json:string name="foo">Bar</json:string>
  <json:boolean name="yes">false</json:boolean>
 </json:object>
</json:object>

Types

Throughout the documentation we use a notation to indicate to type of the data which will be supplied for the field. You can use this to form your internal schema.

Example types are string, integer, boolean, Object (the internal structure of the object is typically defined afterwards). The type Array<string> would mean "an array of strings".

A type prefixed with ? (e.g. ?string or ?Array<string>) indicates "optional/nullable".

When you encounter a nullable field, you can choose to either explicitly include it as null, or just leave the field out entirely.