> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rampnow.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Postman Collection

> Explore and test Rampnow API with Postman

## Overview

Postman is an application designed to help with API integration and exploration. Intuitive for different tech skill levels, it's the tool of choice for both experienced developers and those new to APIs to get familiar with available endpoints, requests, and responses.

Using our Rampnow Postman Collection, you can start testing our API before you write a single line of code. Explore endpoints, understand request/response structures, and validate your integration setup in an interactive environment.

<Note>
  The Postman collection includes pre-configured requests for all major Rampnow API endpoints with built-in authentication headers and sample payloads.
</Note>

## Getting Started with Postman

### Prerequisites

Before importing the Rampnow collection, ensure you have:

* A Rampnow Partner Dashboard account
* Your API Key and Secret Key generated from the Dashboard
* Either the Postman desktop app or Postman web version

### Install Postman

1. **Download and install** the [Postman app](https://www.postman.com/downloads/) or use [Postman online](https://www.postman.com/product/rest-client/)

2. **Create or sign into** your Postman account

### Import the Rampnow Collection

<Steps>
  <Step title="Get the collection link">
    Copy the Rampnow Postman collection link from [here](https://rampnow-io.github.io/core/partner_external-postman.json).
  </Step>

  <Step title="Import into Postman">
    Click the "Run in Postman" button or manually import by:

    * Opening Postman
    * Going to **File** → **Import**
    * Pasting the collection link or uploading the JSON file
  </Step>

  <Step title="Set up environment variables">
    Create or import the Rampnow environment and configure:

    * `api_key`: Your API Key from the Partner Dashboard
    * `api_secret`: Your Secret Key from the Partner Dashboard
    * `base_url`: The API base URL (sandbox or production)
  </Step>

  <Step title="Start exploring">
    Browse the collection folders to explore different API endpoints and test requests
  </Step>
</Steps>

## What's Included

The Rampnow Postman collection includes:

<div style={{display: 'grid', gridTemplateColumns: '1fr 1fr', gap: '1rem'}}>
  <Card title="Authentication" icon="key">
    Pre-configured request signing with HMAC-SHA256 authentication headers
  </Card>

  <Card title="Onramp Endpoints" icon="arrow-down">
    Complete set of onramp API requests for currency conversions and payments
  </Card>

  <Card title="Offramp Endpoints" icon="arrow-up">
    Offramp API requests for converting crypto back to fiat currencies
  </Card>

  <Card title="Quote Requests" icon="quote">
    Real-time pricing and quote endpoints for both onramp and offramp flows
  </Card>

  <Card title="Order Management" icon="list-check">
    Endpoints for creating, updating, and tracking orders
  </Card>

  <Card title="Sample Payloads" icon="code">
    Pre-filled request bodies demonstrating proper payload formatting
  </Card>
</div>

## Using the Collection

### Making Your First Request

1. Select an endpoint from the collection
2. Review the request details (method, URL, headers)
3. Modify the path or query parameters as needed
4. Click **Send** to execute the request
5. View the response in the response panel

### Testing Different Environments

The collection supports both Sandbox and Production environments:

* Switch between environments using the environment selector dropdown
* Sandbox requests go to `https://api.sandbox.rampnow.io`
* Production requests go to `https://api.rampnow.io`

<Warning>
  Always test your integration thoroughly in the Sandbox environment before switching to Production.
</Warning>

## Collection Structure

The collection is organized into folders by functionality:

| Folder                     | Purpose                                   |
| -------------------------- | ----------------------------------------- |
| **Authentication**         | Authentication setup and signing examples |
| **Sandbox Environment**    | Sandbox-specific requests and test data   |
| **Production Environment** | Production API requests                   |
| **Quotes**                 | Quote and pricing endpoints               |
| **Orders**                 | Order creation and management endpoints   |
| **Settlement**             | Settlement and transaction endpoints      |

## Postman Collection Placeholder

<Card title="Rampnow API Collection" icon="mail" href="# placeholder-link-to-postman-collection">
  Import the Rampnow [Postman Collection](https://rampnow-io.github.io/core/partner_external-postman.json)
</Card>

## Next Steps

* Review the [Authentication](./authentication.mdx) guide to understand request signing
* Explore the [API Reference](./overview.mdx) for detailed endpoint documentation
* Test with sample payloads in the Sandbox environment
* Review [Error Codes](./error-codes.mdx) for handling API responses

## Tips & Best Practices

* **Use variables** for frequently changed values (API keys, amounts, addresses)
* **Create custom scripts** in the Pre-request tab to automate timestamp and signature generation
* **Save responses** to keep track of successful requests
* **Use collections** to organize requests by workflow
* **Export results** for documentation and troubleshooting

<Info>
  Need help? Check out the [Postman documentation](https://learning.postman.com/) or contact our support team for assistance with integration.
</Info>