Developers

Appearance

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:

bash
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:

bash
curl --location "https://your-assigned-domain/external/apis/v1.0/healthz"

You should receive a JSON response:

json
{
  "description": "Backend APIs for the Sakneen platform",
  "ok": true,
  "version": "v1.0"
}

A successful public health check does not validate your API key. Test an authenticated, read-only request next:

bash
curl "https://your-assigned-domain/external/apis/v1.0/compounds?page=1&limit=1" \
  -H "api-key: YOUR_API_KEY_HERE"

You can perform both checks in the interactive API reference. Confirm the exact assigned HTTPS origin before entering your key. Request a sandbox/test host and key from support before trying state-changing examples.

Next Steps ​

After connecting to Sakneen:

  1. ✅ Set up your environment variables
  2. ✅ Test the connection with the health check
  3. ✅ Review the Authentication Guide
  4. ✅ Follow the Quick Start Guide
  5. ✅ 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