Endpoints

An endpoint is the address, port, and protocol a web service is exposed at. In short, the web service URL.

​

WebAPI

The HTTP WebAPI comes in two parts:

• REST WebAPI - URLs describe entities like person or sale: Learn | Download Swagger File | Reference
• Agents WebAPI - the services API accessible via HTTP: Learn | Download Swagger File | Reference

Swagger files for individuals endpoints are also available for both APIs: REST Individuals Swagger | Agents Individuals Swagger. While the Agents WebAPI is the most complete of the two, the REST WebAPI covers the most common use cases and is easier to use and navigate.

​

Getting started

• Get the version number and build date from the API endpoint: /api
• Get a list of supported URLs using the version URL: /api/v1

​

Authorization (WebAPI)

• Authorization options and how to configure them
• How to reuse sessions with XSRF-TOKEN

​

HTTP request headers

• Accept-Language
• Content-Type
• If-Modified-Since and If-Unmodified-Since

​

SOAP

We have initiated phase-out of SOAP proxy client and web service endpoints.Switch to SuperOffice.WebApi (REST). Read more in the EOL notice