Quick Start Guide

Get Started with Waffy APIs

Follow this guide to make your first API call in under 5 minutes. We'll walk you through creating an account, generating API keys, and making your first request.

What you'll learn
Account setup • API authentication • Making requests • Handling responses

1
Create Your Developer Account

Sign up for a free Waffy developer account to get started

First, you'll need to create a developer account. This gives you access to the dashboard where you can manage API keys, view usage analytics, and access documentation.

Sign up options:
Email and password
Google OAuth
GitHub OAuth
Create Account

2
Generate Your API Key

Create a sandbox API key to start testing immediately

Once you're logged in, navigate to the API Keys section in your dashboard. You can generate a sandbox API key instantly—no approval required!

API Key Format:
wf_sbx_1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p
Sandbox keys are prefixed with wf_sbx_

3
Make Your First API Call

Test the user linking endpoint to see Waffy in action

Let's make your first API call! We'll use the user linking endpoint to connect a user to the Waffy platform. This is typically the first step in any integration.

Using cURL

curl -X POST https://sandbox-api.waffyapp.com/v1/users/link \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "phone": "+1234567890",
    "name": "John Doe"
  }'

Using JavaScript

const response = await fetch('https://sandbox-api.waffyapp.com/v1/users/link', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    email: 'user@example.com',
    phone: '+1234567890',
    name: 'John Doe'
  })
});

const data = await response.json();
console.log(data);

Expected Response

{
  "success": true,
  "data": {
    "user_id": "usr_1a2b3c4d5e6f",
    "waffy_token": "wft_1a2b3c4d5e6f7g8h",
    "status": "linked",
    "verification_required": false
  },
  "meta": {
    "request_id": "req_1a2b3c4d5e6f",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

4
Explore More APIs

Now that you've made your first call, explore other endpoints

Great! You've successfully made your first API call. Now you can explore other endpoints to build more complex integrations.

Contracts API

Create and manage multi-party contracts

Explore
Payments API

Process payments and manage transactions

Explore

🎉 Congratulations!

You've successfully made your first API call

You're now ready to build amazing payment experiences with Waffy. Here are some recommended next steps to continue your integration journey.