Getting Started
This guide will walk you through creating your first wallet card using the WalletWerk API.
Step 1: Create an API Key
- Log in to your dashboard
- Navigate to the Developer tab
- Click Create API Key
- Select the scopes you need (start with
campaigns:readandcampaigns:write) - Copy and securely store your API key You'll only see it once!
Keep your API key secure. Never commit it to version control or expose it in client-side code.
Step 2: Make Your First Request
Test your API key by listing your campaigns:
GET
/campaignsRequired scope:
campaigns:readList all campaigns for your organization.
Step 3: Create Your First Campaign
Now let's create a campaign:
POST
/campaignsRequired scope:
campaigns:writeCreate a new campaign for your wallet card program.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Campaign name (e.g., "Summer Concert 2025") |
type | string | Yes | Campaign type: event, membership, coupon, access, or generic |
date | string | No | Event date (ISO 8601 format) |
startTime | string | No | Event start time (HH:mm format) |
Next Steps
- Learn about Core Concepts to understand the data model
- Explore the API Reference for complete endpoint documentation
- Check out Examples for real-world workflows