SignalEDI documentation

6. API Reference

Authentication

All API requests require a Bearer token. Generate an API key from Settings → API Keys.

GET /api/v1/transactions
Authorization: Bearer sk_live_YOUR_API_KEY
Content-Type: application/json

REST Endpoints

Trading partners are created in the dashboard (Settings → Trading Partners) or the developer console; pass the resulting partnerId to the API.

Example: list recent failed transactions:

curl -X GET "https://signaledi.com/api/v1/transactions?status=FAILED&limit=50" \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json"

Code Samples

Complete request examples in multiple languages. Click the tabs to switch between cURL, Node.js, Python, and PHP.

curl -X GET "https://signaledi.com/api/v1/transactions" \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json"

curl -X POST "https://signaledi.com/api/v1/documents/outbound" \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"partnerId":"your-partner-id","documentTypeCode":"850","payload":{"purchaseOrderNumber":"PO-1001","lines":[{"sku":"SKU-1","quantity":1,"unitPrice":10}]}}'

curl -X GET "https://signaledi.com/api/v1/transactions/txn_abc123" \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY"

# SignalEDI signs the string "<X-SignalEDI-Timestamp>.<rawBody>" with HMAC-SHA256.
# The X-SignalEDI-Signature header is "sha256=<hex>". Verify with:
SIGNED="$TIMESTAMP.$BODY"
echo -n "$SIGNED" | openssl dgst -sha256 -hmac "whsec_YOUR_SECRET"

Rate Limits

Numbers above are typical ceilings; the actual cap that applies to your request is the lower of the per-endpoint ceiling and your plan-tier ceiling (see Acceptable Use). Rate-limit response headers (when present): X-RateLimit-Remaining and X-RateLimit-Reset (Unix timestamp). On a 429, retry after the time indicated in the response body or Retry-After header.

Webhook Setup

Configure a webhook URL in Settings → Webhooks to receive document lifecycle updates (validation, routing, partner acknowledgements, and errors) without polling.

SignalEDI sends a POST request to your URL with the following JSON payload:

{
  "event": "document.validated",
  "timestamp": "1710000000",
  "data": {
    "documentId": "doc_01HXYZ",
    "partnerId": "partner_abc",
    "documentTypeCode": "850",
    "status": "validated"
  }
}

Webhook events include document.validated, document.routed, document.partner_ack, and document.error. Deliveries also include X-SignalEDI-Timestamp, X-SignalEDI-Event, and X-SignalEDI-Delivery-ID headers.

Verify webhook authenticity by checking the X-SignalEDI-Signature header (HMAC-SHA256 over timestamp + "." + rawBody using your webhook signing secret; reject deliveries whose timestamp skew exceeds ~5 minutes).