Getting Started
Integrate StablR's API to on- and off-ramp EURR and use it for payments, pay-outs and transfers.
The StablR API contains a set of functions and processes that enable your applications and platforms to automate the minting and redemption of EURR. This provides you with the opportunity to give your users direct access to a 1:1 Euro-backed stablecoin via your own app or website.
To ensure success of the API integration, please note that:
- StablR API requests without authentication will fail.
- All StablR API requests must be made over a HTTPS connection.
- StablR API keys, their corresponding secret, and client ID must be stored and used secure at all times. Never share it or record it in a medium that might be publicly accessible such as client-side code or public repositories.
API Authentication
To authenticate the API requests from your backend server you have to request for a time-bound access token first. You need to set this Access Token in theAuthorization
header of the request using the Bearersecret-key-value
format.
Authorization: Bearer ACCESS_TOKEN
Access Token Expiration
For security reasons Access Tokens are time-bound and expire after five minutes. When you notice error messages on your requests coming in please request a new Access Token for your API requests.
Notification Management
StablR's webhooks are an automated notification service for applications and platforms to receive notifications on events the moment a transaction changes state, is completed or fails. By configuring StablR's webhook notification service, StablR will make a request to your backend server when an event on a transaction is emitted. This removes the necessity for your application or platform to poll StablR for the latest state of a transaction as your application will be updated automatically.
Webhook notifications can be managed in the StablR Account.
Webhook Notification Overview
You can find an overview of your webhook subscriptions in the Notification Management section of the StablR Account. Go to:
- Account
- Management
- Notifications
Add a new Webhook configuration
Create a new webhook subscription by navigating to the Notification Overview in your StablR Account by clicking on Add Hook.
Subsequently, provide the following details:
- Give your webhook subscription a Name, i.e. "Transactions".
- Enter the endpoint URL where you want the notifcations to go to (HTTPS is required).
- Add a Secret so that you can verify the incoming event notifications arriving at your endpoint URL. π
- Click Create to enable the webhook subscription.
Secure your webhook notifcations
The secret that you provide should be a JWT generated token which be included into the header "x-webhook-secret" of every webhook notification request send from StablR.
Remove a Webhook configuration
To remove a webhook subscription you first need to Disable the specific webhook configuration. After you have disabled the respective webhook subscription can be removed by selecting Delete and confirm your action.
Updated 5 months ago