Skip to main content

Get started with the API

Basic Information​

  • Base URL: https://api.uspeedo.com
  • API Version: v2
  • Request Format: JSON
  • Response Format: JSON

Authentication​

All APIs use HTTP Basic authentication. You need to include authentication information in the request headers:

Authorization: Basic base64(ACCESSKEY_ID:ACCESSKEY_SECRET)

Where:

  • ACCESSKEY_ID: Get it here
  • ACCESSKEY_SECRET: Get it here
  • base64(ACCESSKEY_ID:ACCESSKEY_SECRET): Base64-encoded string of ACCESSKEY_ID:ACCESSKEY_SECRET
  • base64_encoded_credentials = base64(ACCESSKEY_ID:ACCESSKEY_SECRET)

Request Headers​

All requests must include the following headers:

  • Content-Type: application/json
  • Authorization: Basic {base64_encoded_credentials}

Path Format​

  • Standard format: /api/v1/{product}/{action}

Where:

  • product: Product name, depending on product type, can be usms, email
  • action: Operation name, such as SendEmailTemplate, SendEmail, etc.

Error Response Format​

{
  "RetCode": error_code,
  "Message": "error_description"
}

API List​

International SMS​

International Email​