API

This page is written for businesses who require more granular, low-level interaction with Uniramp. For most users, we suggest leveraging the Uniramp Widget for hassle-free integration.

Environments

We offer a sandbox environment for development purposes. The sandbox environment allows developers to bypass transactions through our partner's dashboard and will complete DeFi swaps on testnets.

Environments

Endpoint

Authentication

Please complete this form to obtain your API Keys.

The Uniramp API uses API keys to authenticate requests through bearer authentication. Requests are required to include a valid bearer token in the x-api-key header. API requests without authentication will fail. An example of an authenticated request can be found below:

$ curl https://api.uniramp.io/v1/onramp/supported/fiat \
  -H "x-api-key: pk_prod_LGZp4n7498RW5E1IwR3mJ9Ep"

To ensure secure communication and data integrity, the Uniramp API exclusively supports HTTPS for all API requests. Any attempts to make requests over plain HTTP will not be successful.

Types of API Keys

There are a total of four different types of API keys. API keys grant you access to the Uniramp API.

Test secret key Example: sk_sand_LGZp4n7498RW5E1IwR3mJ9Ep Used to authenticate requests on the server (stored as an environment variable or in a credential management system) for the sandbox environment. This key can be used to perform API requests without restrictions. Do not expose this key on any client-side code or store this key on the version control system.
Test publishable key Example: pk_sand_LGZp4n7498RW5E1IwR3mJ9Ep Used to authenticate requests on the client for the sandbox environment. This key can be stored on the client-side code. API access using this key may be more restrictive.
Production secret key Example: sk_prod_LGZp4n7498RW5E1IwR3mJ9Ep Similar to the test secret key, use this key to authenticate requests on the production endpoint. Do not expose this key on any client-side code or store this key on the version control system.
Production publishable key Example: pk_prod_LGZp4n7498RW5E1IwR3mJ9Ep Similar to the test publisher key, use this key to authenticate requests on the production endpoint.

PreviousTheme Uniramp Widget NextGetting Started

Last updated 5 months ago

Environments

Endpoint

Authentication

Please complete this form to obtain your API Keys.

$ curl https://api.uniramp.io/v1/onramp/supported/fiat \
  -H "x-api-key: pk_prod_LGZp4n7498RW5E1IwR3mJ9Ep"

To ensure secure communication and data integrity, the Uniramp API exclusively supports HTTPS for all API requests. Any attempts to make requests over plain HTTP will not be successful.

Types of API Keys

There are a total of four different types of API keys. API keys grant you access to the Uniramp API.

Test secret key Example: sk_sand_LGZp4n7498RW5E1IwR3mJ9Ep Used to authenticate requests on the server (stored as an environment variable or in a credential management system) for the sandbox environment. This key can be used to perform API requests without restrictions. Do not expose this key on any client-side code or store this key on the version control system.

Test publishable key Example: pk_sand_LGZp4n7498RW5E1IwR3mJ9Ep Used to authenticate requests on the client for the sandbox environment. This key can be stored on the client-side code. API access using this key may be more restrictive.

Production secret key Example: sk_prod_LGZp4n7498RW5E1IwR3mJ9Ep Similar to the test secret key, use this key to authenticate requests on the production endpoint. Do not expose this key on any client-side code or store this key on the version control system.

Production publishable key Example: pk_prod_LGZp4n7498RW5E1IwR3mJ9Ep Similar to the test publisher key, use this key to authenticate requests on the production endpoint.