Introduction

OpenAPI-based REST APIs for Isometric Certify and Registry services with authentication, endpoints, and integration examples

Welcome to the documentation for the Isometric Certify and Registry API services.

This reference covers what you need to know to integrate with the Certify and Registry APIs. For product user guides, please review the Isometric Platform documentation.

Our APIs

Isometric’s APIs are OpenAPI-based. This documentation covers the available API endpoints, including usage examples, and instructions around concepts such as authentication and error handling.

We provide APIs for both of our products:

Certify

Submit data for Isometric verification

Registry

Query, deliver and retire credits

Isometric does not currently publish SDKs, but we do provide OpenAPI specs for each API. You can download the specs in JSON format here:

Certify API

Registry API

The OpenAPI files can be used to autogenerate a client library in your language of choice, import as a collection into API testing software or generate a local copy of the API documentation.

Request Access

To request access to our APIs please complete the become an Isometric partner form.

Environments

The Production API is hosted at:

https://api.isometric.com/

There is also a Sandbox environment available at:

https://api.sandbox.isometric.com/

Accounts and API credentials are independent across the two environments. Please ensure you are using the correct credentials and endpoints for the environment you are building against.

API introduction

Authentication

Learn how to authenticate requests to our API services

Standards

Review common standards used across our APIs

Rate limits

Our Production and Sandbox environments run on infrastructure that scales according to request load, however steep increases in request rate may trigger 429 responses.

API integrations should implement exponential backoff strategies if rate limits are triggered. A conservative rate limit that should avoid triggering 429 responses is around 120 requests per minute.

Sending your first request

Once you have your API keys, you can start sending requests to the Isometric API. An example query to get all projects would look like this:

bash

curl --request GET \
  --url https://api.sandbox.isometric.com/registry/v0/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-secret: <x-client-secret>'

Terms of usage

All API users must abide by Isometric’s Terms and Conditions.