Getting Started

This guide will walk you through the initial setup and basic integration of PocketDNS into your platform.

Prerequisites

Before you begin, make sure you have:

• A web application where you want to embed domain functionality
• Basic knowledge of REST APIs and JavaScript/TypeScript
• SSL-enabled domain for production deployment

Account Setup

1. Create a Partner Account

Visit our partner dashboard at https://dashboard.pocketdns.com and sign up with your business email and details.

2. Generate API Keys

1. In your partner dashboard, navigate to "API Keys"
2. Click "Create New API Key" and give it a descriptive name
3. Important: Save the generated key securely - it's only shown once
4. Make sure your API key is for the correct environment (sandbox or production)

Environment URLs

Choose the appropriate base URL for your integration:

• Sandbox: https://api.sandbox.pocketdns.com
• Production: https://api.pocketdns.com

INFO

Always start with the sandbox environment for development and testing!

Quick Integration Test

Let's test your API key with a simple user session creation:

curl -X POST https://api.sandbox.pocketdns.com/api/v1/users \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "user_identifier": "test-user-123",
    "email": "[email protected]"
  }'

If successful, you'll receive a response with a login_url that you can use to embed the domain interface.

Next Steps

Now that you have your API key set up:

1. Read the Authentication guide to understand security best practices
2. Follow the Integration Guide for step-by-step implementation
3. Explore the API Reference for detailed endpoint documentation

Security Note

Never expose API keys in client-side code. Always make API calls from your server.