You are here

You are here

REST API Overview

API Base URLs

All API URLs use the following format:

https://[base url]/[version]/[resource identifier]

SpringCM is distributed across several data centers. Base URLs for the Object, Task and Content APIs are data center specific.  Base URLs for authentication are NOT data center specific.  To prevent developers from having to store base URL information in their application code, the base URL for the Object and Task APIs is returned after a successful authentication request.  Content API URLs are properties of the Document and Folder objects and are discoverable at run time.

The entry point for authentication regardless of data center is as follows:

Production Authentication Endpoint

https://auth.springcm.com

UAT Authentication Endpoint

https://authuat.springcm.com

As mentioned above, datacenter specific base URLs are passed back from a successful authentication call, however the URLs are also listed below for reference purposes.  Note the datacenter of an account can be obtained by looking at the subdomain of the URL after logging into the SpringCM user interface (ie na11, na21, etc.).  Additionally, the REST API base URLs can be found within the SpringCM user interface by navigating to Help->SpringCM Resources

Production Endpoints

Production Object API

https://api[datacenter].springcm.com

Production Task API

https://api[datacenter].springcm.com

Production Content Upload API

https://apiupload[datacenter].springcm.com

Production Content Download API

https://apidownload[datacenter].springcm.com

UAT Endpoints

UAT Object API

https://apiuat[datacenter].springcm.com

UAT Task API

https://apiuat[datacenter].springcm.com

UAT Content Upload API

https://apiuploaduat[datacenter].springcm.com

UAT Content Download API

https://apidownloaduat[datacenter].springcm.com

Versioning

The authentication and application URLs are versioned separately.  The current versions are:

Authentication Current Version

v201606

Application APIs Current Version

v201411

Request/Response Formats

The SpringCM Object and Task APIs support JSON for all requests and responses.  The Content API by default will download documents in the native format they were uploaded.  For certain document types, SpringCM will also maintain a copy of the document in additional formats such as PDF, png, or text.  See the Content API documentation for more information.