Skip to content

Developers#

Welcome! This section is for developers building against the CMDS API - whether you're wiring CMDS into another system, pulling data for reports, automating a workflow, or integrating with a partner platform.

If you're just getting started, read Introduction in the API section to make your first request.

What you'll find here#

API#

  • Introduction - base URLs, environments, Swagger reference, and a quick-start path to your first successful request.
  • Authentication - personal API secrets, the shared service key, and session cookies.
  • Request and response formats - conventions for HTTP methods, field selection, status codes, and errors.
  • Example - a step-by-step walkthrough of calling the compliance summary endpoint from your own system.
  • Rate limits and throttling - the per-credential request limits, the 429 response, and how to back off.

Resources#

  • .NET - which .NET versions we target and why.
  • Date and time values - how the API formats timestamps (ISO 8601 with time zone) and why it matters.

Integrations#

  • Power BI - step-by-step guide to connecting Power BI to CMDS as a data source.

Need help?#

If you're stuck or hit something unexpected, reach out to CMDS Administration (admin_cmds@keyera.com) - we're happy to help you get unblocked.