API Overview

The Core API is a RESTful web service. It allows you to control Core through a third-party application using JSON for both request and response payloads. Some URLs include inline parameters or query parameters, while some URLs take POST payloads to execute. GET, PUT, POST, and DELETE methods are available, depending on the call.

Access & Authentication

The API is available to all Resolver Enterprise and Professional customers through Swagger, a web-based API browser. Swagger displays a description of the expected usage and response payloads, allowing you to test the calls within the tool.

Users can authenticate through an API key or session token. See API Keys and Session Tokens for more information.

Limitations

If you can perform the action through the UI, that same action can be performed via the API. However, some actions may involve numerous API calls, complex payloads, or calls that may require assistance from Resolver Support.

Testing & Development

To avoid unexpected performance degradation in your production environment, all integration development and API testing should be completed on a sandbox environment.

Curl

Swagger automatically generates Curl examples when a command is executed. Curl is a simple command line data utility included with most operating systems, including Windows, Mac, and Linux.

curl -X GET --header 'Accept: application/json' --header 'Authorization: bearer TOKEN

Before executing a Curl command in Windows, ensure all single quotes [ ' ] are replaced with double quotes [ " ]. Attempting to execute a command using single quotes will result in the following error:

curl : (1) Protocol https not supported or disabled in libcurl

When using cURL in Windows PowerShell, make sure to call curl.exe as Microsoft has made Curl a default alias for Invoke-WebRequest.