API Reference

REST API

Integrate Badex Signature into your own applications using our simple REST API.

Authentication Get Signature Endpoints Rate Limits Error Codes

Authentication

The signature API is currently open for internal use — requests are only accepted from the SMTP server's IP address. External API access with API keys is coming in a future release.

Get Signature

Returns the rendered HTML signature for a given email address.

GET /api/signature?email={email}

Parameters:

ParameterTypeRequiredDescription
emailstringYesThe sender's email address

Success Response (200):

{
  "success": true,
  "email": "[email protected]",
  "policy": {
    "id": 1,
    "name": "Default Policy",
    "match_type": "domain",
    "match_value": "company.com",
    "priority": 100
  },
  "html": "<table style=\"font-family:Arial...\">...</table>"
}

Error Response (404):

{
  "success": false,
  "message": "No signature policy or template found"
}

All Endpoints

MethodEndpointDescription
GET /api/signature Get rendered signature HTML
GET /api/track/open Track email open pixel
GET /api/track/click Track link click
GET /api/banner/click Track banner click
POST /api/email-log Log processed email

Rate Limits

The API is designed for high-volume email processing. Current limits:

  • No rate limits for internal SMTP server requests
  • Responses are cached for 5 minutes per email address
  • Cache is invalidated when a template or policy is updated

Error Codes

CodeMeaning
422 Invalid email address format
404 No signature policy or template found for this email
500 Internal server error — check logs