Developer documentation
Connect your own systems to TAS Technologies Group's messaging services. Each API is a plain JSON API with a bearer key, and each reference covers authentication, errors, rate limits and every endpoint, with a request you can paste into a terminal.
Getting an API key
Keys are made in Admin-IQ, the portal your account is managed from. An account admin opens the service's API page, creates a key on its Keys tab and chooses what it may do. The key is shown once, so store it somewhere safe on your server. Admins can rotate or revoke keys there at any time, and a revoked key stops working on its next request.
Not a customer yet, or need the service added to your account? Get in touch and we will set you up.
What both APIs share
JSON over HTTPS
Requests and responses are JSON, under /api/v1 on each service's host. The one exception is sending a fax as a file upload, which is multipart.
A bearer key per service
Send your key as Authorization: Bearer <key>. It identifies your account, so there is no account parameter. Each service issues its own keys, with scopes chosen when the key is made.
Your records only
A key reads and writes only its own account's data. A record that belongs to anyone else answers 404, exactly as one that does not exist.
One envelope
Success is { "success": true, "data": … }, with pagination beside data on lists (limit and offset). Failure is { "error": { "message", "code", "correlationId" } } with an HTTP status to branch on.
Correlation ids
Every response carries x-correlation-id. Quote it when you contact us, or send your own and it is echoed back.
Rate limits
Roughly 100 requests a minute per source address, reported in x-ratelimit-limit, -remaining and -reset (seconds until the window resets). Over the limit is a 429.