Skip to main content

Getting Your Domain

Before you can start using the Sakneen API, you need to obtain your assigned domain from our support team.

What You'll Receive​

When you contact Sakneen support, you'll receive:

  • API Key: Your unique authentication key
  • Production Domain: Your assigned production domain (e.g., client-api.sakneen.com)
  • Staging Domain: Your staging environment domain (e.g., client-staging.sakneen.com)
  • Documentation: Any client-specific configuration notes

Contact Information​

Email: [email protected]

What to Include in Your Request:

  • Company name
  • Primary contact information
  • Intended use case for the API
  • Expected request volume
  • Preferred domain prefix (if you have one)

Domain Examples​

Your domains will typically follow these patterns:

Production: https://your-company.sakneen.com
Staging:    https://your-company-staging.sakneen.com

Or:

Production: https://api-your-company.sakneen.com
Staging:    https://api-your-company-staging.sakneen.com

Environment Variables Setup​

Once you receive your domains, set up your environment variables:

Production​

SAKNEEN_API_KEY=your-production-api-key
SAKNEEN_DOMAIN=your-company.sakneen.com
NODE_ENV=production

Staging​

SAKNEEN_API_KEY=your-staging-api-key
SAKNEEN_DOMAIN=your-company-staging.sakneen.com
NODE_ENV=staging

Development​

SAKNEEN_API_KEY=your-development-api-key
SAKNEEN_DOMAIN=localhost:8081
NODE_ENV=development

Testing Your Domain​

Once you receive your domain, test the connection with the health check endpoint first:

curl --location "https://your-assigned-domain/external/apis/v1.0/healthz" \
  --header "api-key: your-api-key"

You should receive: API is healthy

Then test creating a lead:

curl -X POST "https://your-assigned-domain/external/apis/v1.0/leads" \
  -H "api-key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Test Lead",
    "phoneNumber": "+1234567890",
    "project": "Test Project",
    "email": "[email protected]"
  }'

Next Steps​

After receiving your domain:

  1. ✅ Update your environment variables
  2. ✅ Test the connection with a simple API call
  3. ✅ Review the Authentication Guide
  4. ✅ Follow the Quick Start Guide
  5. ✅ Explore Integration Examples

Support​

If you have any issues with your domain setup or need assistance:

  • Email: [email protected]
  • Include your domain and any error messages
  • Our team typically responds within 24 hours