Skip to main content

Prerequisites

Introduction​

This getting started guide will walk you through the basic operations you can take to create your first retirement through the MyPuro 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 MyPuro API.

More detailed instructions for the concepts of this API can be found in Concepts. You can also refer to the OpenAPI specification to get more information about the API endpoints.

Getting access to MyPuro API​

Contact Puro.earth to get access to MyPuro Portal, and for signing the API agreement. Once the agreement is signed, you can enable API access to your selected resources in the MyPuro Portal such as accounts, balances and transactions. To authenticate and use the resources in the API, you can generate API keys from the MyPuro Portal.

Authentication and Authorization​

Once the API agreement has been signed, one can start generating API keys in the MyPuro Portal to use the MyPuro 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 and Access Management guide how to enable API access to your own resources, and how to generate API keys to use the API endpoints.

Before starting, please make sure you have enabled the following access rights for yourself in the MyPuro Portal, and you have some testing CORCs in your account:

Access rights

Following access rights need to be enabled for API usage for yourself in the MyPuro Portal to finish the Getting Started guide:

  • Read Account Holders to list and get Account Holder details
  • Read Accounts to list your account information
  • Read Account Balance to get balance for one of your testing accounts, from where you will retire the CORCs in this guide
  • Create Retirement for creating the retirement
  • Read Transaction to list and get transactions

See Access management for more details about enabling access to MyPuro resources.