The SDK & API Settings page allows you to generate and manage API keys for programmatic access to your PawPlacer data. This enables integration with other software systems and automated workflows.
Deprecation notice: The legacy REST API is deprecated. It remains available and fully supported through at least the end of 2026, but all new integrations should adopt the PawPlacer SDK for long-term compatibility and access to new capabilities.
Overview
PawPlacer's SDK provides typed, authenticated client helpers for the most common integration scenarios and keeps pace with platform features. The legacy public API continues to expose read and create operations for pets marked as public so that existing integrations can:
- Retrieve pet information for display on external websites
- Automate data synchronization with other systems
- Build custom integrations and workflows
- Access your data programmatically
API Key Management
Generating Your First API Key
When you first visit the SDK & API Settings page, you'll need to generate an API key:
- Click the "Generate New API Key" button
- Your new API key will be displayed
- Important: Copy this key immediately - it won't be shown again
- Store the key securely in your password manager or secure documentation
API Key Security
Your API key provides full access to your organization's data. Treat it like a password:
- Never share your API key publicly
- Don't commit it to version control systems
- Don't include it in client-side code
- Store it securely and limit access to trusted team members
Rotating Your API Key
If your API key may have been compromised or you want to update it for security:
- Click the "Rotate API Key" button
- Confirm that you want to generate a new key
- Your old key will immediately stop working
- Copy and securely store your new key
- Update any systems using the old key
Prefer the SDK
The PawPlacer SDK should be your default choice for new development. It handles workspace-scoped authentication, implements the latest rate limiting guidance, provides TypeScript typings, and keeps in sync with platform-level RLS and validation rules. The SDK also unlocks future enhancements such as realtime updates, richer error diagnostics, and automatic retries without any additional client work.
Continue to store your SDK credentials securely and rotate them on the same cadence as API keys.
Legacy API Status
The REST API is deprecated and receives security updates only. It will stay online through at least 2026 so existing integrations keep working while teams migrate to the SDK. No new endpoints or features will be added, and the dedicated documentation will sunset alongside the retirement. Reach out to support if you encounter blockers while transitioning.