Quick Start Guide
Learn how to integrate Paws Source into your application in under 5 minutes. This guide covers authentication, creating your first pet profile, and triggering your first care event.
You'll need an active Paws Source Developer account, an API key, and Node.js 18+ installed.
1. Install the SDK
We provide official SDKs for JavaScript/TypeScript, Python, and Go. The SDK handles authentication, retry logic, and response parsing automatically.
# Install via npm
npm install @pawssource/sdk
# Or via yarn
yarn add @pawssource/sdk
2. Authenticate
All requests require a valid API key. Keep your keys secure and never expose them in client-side code. Use environment variables for production.
import { PawsSource } from '@pawssource/sdk';
const client = new PawsSource({
apiKey: process.env.PAWSSOURCE_API_KEY,
environment: 'production' // or 'sandbox'
});
// Verify connection
const status = await client.health.check();
console.log(status); // { ok: true, version: '2.4.1' }
API keys are limited to 100 requests per minute in the free tier. Upgrade to Pro for 1,000 RPM and priority routing.
3. Create a Pet Profile
Every interaction in Paws Source revolves around a pet profile. Below is a minimal example creating a new dog profile with basic health metadata.
const pet = await client.pets.create({
name: 'Buster',
species: 'canine',
breed: 'Golden Retriever',
age_months: 24,
weight_kg: 30.5,
microchip_id: '985112001234567',
owner: {
name: 'Sarah Mitchell',
email: 'sarah@example.com',
phone: '+15550123456'
},
preferences: {
dietary: 'grain-free',
allergies: ['chicken', 'soy']
}
});
console.log(`Created pet ID: ${pet.id}`);
Response Schema
| Field | Type | Description |
|---|---|---|
id |
string | Unique identifier (UUID v4) |
created_at |
ISO 8601 | Timestamp of creation |
status |
enum | active, inactive, archived |
care_plan |
object | Default nutrition & grooming schedule |
4. Configure Webhooks
Receive real-time updates when a pet's vitals change, a vet consultation completes, or a grooming session finishes. Set your endpoint in the dashboard or via API:
await client.webhooks.create({
url: 'https://your-app.com/api/paws-events',
events: ['pet.vitals.updated', 'consultation.completed'],
secret: process.env.WEBHOOK_SECRET
});
You now have a working Paws Source integration. Check out the API Reference for advanced endpoints or Webhook Signatures for security verification.