API documentation

Overview

The SAFc Registry API is an additional mode for using the registry that can unlock some business use cases (e.g., automating reading data from the registry or taking actions on the registry).

The registry API can be used by generating an API token to securely authenticate with the registry's backend each time you make a request. Each API token is tied to an individual and inherits all of their roles/abilities.

So, if Alice has an API token associated with her email ([e-mail]) and someone adds her to their account as an Account Representative with read only access, Alice's API token will gain access to read the data from that account.

Getting started

Setting up your authentication tokens

Log in and click the user icon in the top right corner of the screen

Navigate to the Profile settings page

Select the "Auth Tokens" tab and click "Create new Auth Token"

The new Auth Token will only be displayed once for security purposes and you must record it at this time. If you lose your token, you'll need to create a new one.