Introduction

Introduction

Go to the Ramp API Documentation website. This is where you’ll find details on all available endpoints, authentication methods, and how to interact with the API.

Sign Up for a Ramp Account

  1. Create an Account:
    • Go to the Ramp website.
    • Click on the “Sign Up” button (usually located in the top right corner).
    • Fill out the registration form with your information (email, password, etc.), and complete any necessary verification (e.g., email verification).
  2. Verify Your Email (if necessary):
    • Check your inbox for a verification email from Ramp.
    • Click on the verification link to confirm your email address.

Log in to Your Ramp Account

  1. Log In:
    • Once you’ve verified your email, log into your Ramp account by clicking on the “Log In” button.
    • Enter your credentials (email and password).

Access the API Keys Section

🔑 How to Access Your API Keys

To access your API keys on Ramp, follow the steps below:

  1. Login to your dashboard at https://dashboard.connectramp.com.
  2. On the left-hand menu, click on “Business Settings.” 
  3. Inside the Business Settings page, navigate to the “API Keys” section.
  4. You’ll see the interface with the following credentials displayed:
    • Public Key 
    • Secret Key 
    • Encryption Key 
    • Initialization Vector (IV) 

Each key section has a copy icon beside it for quick copying and a button to generate new keys if needed.

🛡️ Keep your Secret Key and Encryption Key confidential—never share them publicly or include them in client-side code.

Use the API Keys for Authentication

To authenticate with the Ramp API, you’ll typically use your API keys in your HTTP requests.

1. Authentication:

  • Bearer Token: For most API calls, you will include your Secret Key in the Authorization header of your HTTP requests as a Bearer token.

Example of an API call using curl with your Secret Key:

curl -X GET “https://api.connectramp.com/v1/transactions” -H “Authorization: Bearer YOUR_SECRET_KEY”
The YOUR_SECRET_KEY should be replaced with your actual secret key.

2. API Request Examples:

Here is an example of making a request to retrieve transactions:

curl -X GET “https://api.connectramp.com/v1/transactions” -H “Authorization: Bearer YOUR_SECRET_KEY”
Ensure your Secret Key is included as a Bearer token for secure access to your account’s data.

3. Query Parameters:

    • Some API endpoints may require additional query parameters (like account numbers, date ranges, etc.) as part of the URL.
    • Refer to the Ramp API documentation for the specific parameters for each endpoint.

Review the API Documentation for Further Details

  • You can find more details, like rate limits, error handling, and endpoint-specific instructions, in the Ramp API documentation.
  • Each endpoint in the API documentation will show how to structure the request and what kind of response you can expect.

Start Making API Requests

Now that you have your API keys and authentication method, you can start integrating Ramp’s services into your application.

Key Points:

  1. Sign Up for Ramp at Ramp website.
  2. Generate API Keys through your developer dashboard once logged in.
  3. Authenticate by including your Secret Key in the Authorization header for API requests.
  4. Explore the API Docs for detailed information on available endpoints and usage examples.