Prerequisites

Introduction

This getting started guide will walk you through the data available for reading from the Registry API. Before you can start using the API, you need access to the MyPuro Portal to generate API keys. Please read instructions below for more information about how to get access and authenticate to Registry API.

More details on specific topics can be found in the Concepts section. You can also refer to the OpenAPI specification to get more information about the API endpoints.

Getting access to Registry API

If you're interested in using the Registry API, contact Puro.earth to get API access. For authenticating and fetching data from the Registry API, you can generate API keys from the MyPuro Portal.

Authentication and Authorization

Once you've contacted Puro.earth and API access has been enabled for you, one can start generating API keys in the MyPuro Portal to use the Registry API. The keys have a set time of expiry, which can be selected by the user. The keys are passed to the API in basic authentication header. Please refer to the Authentication guide how to generate and use the API keys.

Before starting, please make sure you have generated an API key in the MyPuro Portal to use the API.