Skip to main content
AllScale Open API
Version: v1
Last updated: 2026-01-21

Overview

AllScale APIs use HMAC-SHA256 request signing to authenticate and authorize third-party requests. This mechanism provides:
  • Strong authentication (shared secret)
  • Replay-attack protection
  • Tamper-proof request integrity
  • Stateless verification
  • Enterprise-grade security
Every API request must be signed using:
  • API Key
  • API Secret

Credentials

When your store or integration is created, you receive: Important:
  • The API secret is shown only once
  • It cannot be retrieved later
  • Store it securely
  • Treat it like a password or private key

Required Request Headers


Request Signing Logic

Canonical String Format

Joined using newline characters.

Example


Signature Algorithm

Algorithm:
Encoding:
Formula:
Header format:

JavaScript / Postman Example


Replay Protection

All requests are protected using timestamp and nonce validation. Rules:
  • Timestamp must be within ±5 minutes
  • Each nonce can be used only once
  • Replayed requests are rejected

IP Allowlist

If configured, requests must originate from approved IP ranges. Examples:
Empty allowlist means all IPs are allowed.

Error Response Format

Error Codes


Rate Limiting

Requests may be rate-limited. Example response:

Debugging Tips


Best Practices

  • Always use HTTPS
  • Use UTC timestamps
  • Store secrets securely
  • Rotate secrets regularly
  • Log request IDs
  • Never expose secrets in frontend code
  • Never reuse nonces

End of document.