Endpoints

Some tooltip text!

• 2 minutes to read

 • 2 minutes to read

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

Note

If your installation is protected from the internet by a reverse proxy, the URLs generated by the WebAPI will be wrong. For more info, see the IIS config section.

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

• Learn about the SOAP API endpoints such as Services88.
• Use a built-in or custom proxy.
• Check out the latest reference.

Authorization (SOAP)

• Proxy authentication using SoSession
• Direct authentication using a Ticket