NAR API Overview
The NAR Registry has released a set of user-facing APIs. This initial release is focused on APIs necessary to transact certificates. These RESTful APIs include endpoints for the following:
-
GET Certificate Holdings
Returns certificate holdings belonging to the specified account holder(s).
-
GET List of counterparties
Returns a list of accounts from the registry. These accounts may be specified as counterparties to certificate transfers.
-
POST Certificate Transfers
Initiate the transfer of certificates to another account holder.
-
GET Pending Transfers
Returns a list of pending transfers (incoming and outgoing).
-
POST Certificate Transfer Actions
Take action on pending transfers. Confirm or reject incoming transfers or withdraw outgoing transfers.
-
GET Sub-Accounts
Returns a list of sub-accounts (Active, Retirement, etc.). These sub-accounts can be specified for sub-account transfers and retirements
-
POST Sub-Account Transfers
Transfer certificates within an account.
-
POST Certificate Retirement
Initiate retirements for an account.
Account Managers can create API Logins for their own accounts or delegate another account holder to act on their behalf through the API.
Further technical documentation will be provided detailing how users will authenticate against the API (OAuth2), and the details of each endpoint.
Creating an API Login
The first step in accessing the NAR API is to create an API Login, which can be done by an Account Manager through the NAR registry interface.
-
Login into NAR as an Account Manager
-
In the Account Management module on the home page, click on the link for ‘API Management’”
-
On the API Management page that opens, users have the option of creating their own API Login, or delegating API access to another Account Holder that already has an API login:
-
If the user creates their own login, it will be created in ‘Inactive’ status. The registry admin will be notified and will review the login for approval.
-
While the login is awaiting approval, or after it is approved, the user must add the IP addresses of the machines that will be used to access the NAR APIs:
These IP Addresses will also have to be approved by the registry admin. Please send an email to nar@apx.com for approval of IP address.