Quick Start

OneRamp SDK is the simplest and quickest way to enable faster and cheaper offramping crypto to mobile money services in your app. To get started, you will need to set up an account to access the OneRamp Dashboard in order to generate API keys for new apps (projects), monitor and manage transactions, and get access to new APIs to tap into more developer resources.

Follow these steps to get started, it's super quick!

Get your API keys

Create an account using your GithHub developer account on the OneRamp dashboard. This will prompt you to create a new app for first time users.

Create your app by entering it's app name, category and description and click save

Create an account

On the final tab called API Keys, you'll find your app API keys generated. These are unique and tied to your app. Do not share them.

Your API keys will allow you to authenticate requests on OneRamp.

Get your API Keys

These keys will allow you to authenticate requests on OneRamp.

Using the API

Applications that plan to go beyond the javascript and npm world, can use the full external OneRamp API.

Find the full API documentation here

Using the NPM package

To install OneRamp , you can run:

# Install Oneramp NPM package
npm i @oneramp/sdk

Or

# Install using yarn
yarn add @oneramp/sdk

Import

Import the OneRamp class from the package and create a new instance by providing the necessary parameters:

import { OneRamp } from '@oneramp/sdk';

Or

const { OneRamp } = require('@oneramp/sdk');