BigShop API Quickstart
Welcome to the BigShop API! This guide will help you get up and running in minutes. You'll learn how to authenticate and make your first API call to manage your repair shop programmatically.
Base URL
All API requests should be securely prefixed with:
https://api.bigshopai.com/v1
Prerequisites
Before you begin, ensure you have:
- A BigShop account (if you don't have one, sign up here).
- Tenant Administrator access to generate API keys.
- A terminal with
curlinstalled, or an API client like Postman.
Get your API Key
BigShop uses API Keys for server-to-server authentication. To get your key:
- Log in to your BigShop dashboard.
- Navigate to Settings > Developer API.
- Click Generate New Key.
- Give your key a descriptive name (e.g., "Integration Test").
- Copy the key immediately. You won't be able to see it again!
Security Warning
Never share your API keys or commit them to public code repositories. If a key is compromised, revoke it immediately in the dashboard.
Make your First Request
Let's verify your connection by calling the /health endpoint. This endpoint
doesn't require authentication.
curl https://api.bigshopai.com/v1/healthNow, let's fetch your shop's customer list using your new API Key.
curl -X GET "https://api.bigshopai.com/v1/customers?limit=5" \
-H "Authorization: ApiKey YOUR_API_KEY"You should receive a JSON response looking something like this:
{
"items": [
{
"id": "cust_123abc...",
"name": "Acme Trucking Co.",
"email": "dispatch@acmetrucking.com",
"phone": "+15550123456",
"type": "company",
"createdAt": "2024-03-15T10:30:00Z"
}
],
"total": 1,
"offset": 0,
"limit": 5
}