Skip to main content
This guide will help you make your first API request to Chariow in under 5 minutes.

​
Prerequisites

Before you begin, you’ll need:
A Chariow account with an active store
An API key from your store settings

​
Step 1: Get Your API Key

1

Log in to your dashboard

Go to app.chariow.com and sign in to your account.
2

Navigate to API Settings

Click on Settings → API Keys in your store dashboard.
3

Create a new API key

Click Create API Key, give it a name (e.g., “Development”), and copy the generated key.
Your API key will only be shown once. Make sure to copy and store it securely.

​
Step 2: Make Your First Request

Let’s verify your API key by fetching your store information: 
curl -X GET "https://api.chariow.com/v1/store" \
  -H "Authorization: Bearer sk_live_your_api_key_here"
You should receive a response like this:
Response
{
  "message": "success",
  "data": {
    "id": "str_abc123xyz",
    "name": "My Awesome Store",
    "description": "Selling digital products",
    "logo_url": "https://cdn.chariow.com/stores/logo.png",
    "url": "https://mystore.chariow.com",
    "status": "active"
  },
  "errors": []
}

​
Step 3: List Your Products

Now let’s fetch your published products: 
curl -X GET "https://api.chariow.com/v1/products" \
  -H "Authorization: Bearer sk_live_your_api_key_here"

​
Step 4: Initiate a Checkout

Create a checkout session to process a sale: 
curl -X POST "https://api.chariow.com/v1/checkout" \
  -H "Authorization: Bearer sk_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "prd_abc123",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "phone": {
      "number": "1234567890",
      "country_code": "US"
    }
  }'

​
What’s Next?

Authentication

Learn more about API authentication

Products Guide

Learn how to work with products

Checkout Guide

Master the checkout flow

Pulses

Set up real-time notifications