This documentation covers the Email Service API authentication and key management.

Registration

  1. Go to https://platform.sendr.app/auth/sign-up and create your account.
  2. Verify email address
  3. Next you have to fill your account details:
  • Workspace name: usually your company name like mycompany
  • Default Domain name: mycompany.com
  • Default sending email: example@mycompany.com
  1. Enter your Profile details: First and Last name and Save it

Domain DNS verification

You’ll receive an email with DNS settings for your domain. You need to update your DNS records accordingly.
Important: You can have ONE domain per one tenant/workspace. To add more domains, create additional workspaces/tenants using the UI or API.

Required DNS Records Example

  1. DKIM Record
    • Type: TXT
    • Name/Host: mail._domainkey.mycompany.com
    • Value: v=DKIM1; k=rsa; p=XXX+XXXX/XXX/XXX/XXX/XXX/XXX
    • TTL: 3600 (or Auto)
  2. SPF Record
    • Type: TXT
    • Name/Host: mycompany.com
    • Value: v=spf1 a mx include:spf.sendrapp.org ~all
    • TTL: 3600 (or Auto)

Authentication

The Email Service API uses API key authentication for all endpoints. Each request must include an API key in the Authorization header.

Getting Your API Key

  1. API key generating automatically with limited scopes and sending after domain onboarding to the SENDR platform. Please check your email.
  2. Sometimes you might be need to regenerate your API key.
  3. Log in to your Sendr account
  4. Navigate to the API Keys section
  5. Generate a new API key or modify an existing one

Using Your API Key

Include your API key in the Authorization header of every request:
Authorization: your-api-key-here

Security Best Practices

  • Keep your API keys secure and never share them publicly
  • Rotate your API keys regularly
  • Use different API keys for different environments (development, staging, production)
  • Monitor your API key usage for any suspicious activity

Rate Limits

Each API key has rate limits to ensure fair usage:
  • Default limit: 100 requests per minute
  • Rate limit headers are included in all responses
  • Monitor your usage through the response headers

Error Handling

If your API key is invalid or expired, you’ll receive a 401 Unauthorized response. Check the error message for details on how to resolve the issue.