Connecting to Sakneen
Before you can start using the Sakneen API, you need to get your credentials from our support team.
What You'll Receive
When you contact Sakneen support, you'll receive:
- API Key: Your unique authentication key
- API Domain: Your assigned API endpoint
- 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
Environment Variables Setup
Once you receive your credentials, set up your environment variables:
SAKNEEN_API_KEY=your-api-key
SAKNEEN_DOMAIN=your-assigned-domain
Testing Your Connection
Once you receive your credentials, test the connection with the health check endpoint first:
curl --location "https://your-assigned-domain/external/apis/v1.0/healthz"
You should receive a JSON response:
{
"description": "Backend APIs for the Sakneen platform",
"ok": true,
"version": "v1.0"
}
Then test an authenticated request:
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 connecting to Sakneen:
- ✅ Set up your environment variables
- ✅ Test the connection with the health check
- ✅ Review the Authentication Guide
- ✅ Follow the Quick Start Guide
- ✅ Explore Integration Examples
Support
If you have any issues connecting or need assistance:
- Email: [email protected]
- Include your domain and any error messages
- Our team typically responds within 24 hours