Quickstart

This guide will get you all set up and ready to use the Protocol API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.

Choosing the API Type

We have a restful API that you can use to integrate with our platform. You can use the API to create, update, recipients, and transacts. You can also use the API to retrieve information about your account which also include the B2B and B2C implementation

In the otherside we have a Webview Client implementation for the mobile apps that aim to do a simple integration using only a client secret

Please contact admin@rampable.co for the client secret access and more information.

Making your first API request

After picking your preferred client, you are ready to make your first call to the Rampable API. Below, you can see how to send a GET request to the Conversations endpoint to get a list of all your conversations. In the cURL example, results are limited to ten conversations, the default page length for each client.

curl -G https://sandbox.rampable.co/healthcheck

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the Rampable API:

• Grab your API key from the Rampable dashboard
• Check out the Recipient endpoint
• Learn about the different error messages in Rampable