Before You Begin

What is an API and who uses it?

An API is a tool that allows machine-to-machine communication, meaning your software systems can talk to each other automatically without someone needing to step in and move information around. With the Rev.io API, your other business tools—like your CRM, provisioning systems, or usage platforms—can securely send data into Rev.io or pull data out whenever it's needed.

For business leaders, the value is simple:

• Less manual work for your teams
• Fewer errors from re-keying or duplicate data entry
• Faster processes that keep systems aligned automatically
• Clear, consistent information across your organization

While a developer or IT professional typically sets up the connection, the operational efficiency and reduced overhead benefit the entire business.

Before you begin - Things to know

• Access & roles: API access honors your Rev.io role permissions. Ask an admin to confirm your role allows the actions you plan to call.

• Base URL: https://apim.psarev.io/

  • Endpoints will have the base and the calls will be appended to the base URL.

• Tenant (required): Pass your PSA domain (e.g., acme.psarev.io) in the X-Revio-Host header on every call.

• Environments: Use a sandbox tenant for testing to avoid impacting production data.

• Explorer & scripts run against the tenant you specify. Production tenants will modify live data.

• Security notes

  • Keep API keys and JWTs out of logs; use env vars or a secrets manager.
  • Always use HTTPS.

Action Definitions

• GET

  Retrieves information from a system without making any changes. It's like looking something up to see what currently exists.

• POST

  Creates something new in the system, such as adding a new customer or record. Think of it as submitting a form for the first time.

• PUT

  Replaces an existing item with a new, full version of that item. It's used when you want to update all fields at once.

• PATCH

  Updates only specific parts of an existing item without replacing the whole thing. It's ideal for small, targeted changes.

• DELETE

  Removes an item from the system entirely. It's the digital equivalent of deleting a file or record.

Tenancy & host routing

What "tenancy" means

Rev.io is multi-tenant. Every API call must target a specific tenant (your PSA site). In the new platform, you specify the tenant with the required X-Revio-Host header (e.g., acme.psarev.io). Your bearer token + this header determine which tenant data you can access.

How auth works (quick overview)

Exchange your API key for a short-lived JWT, then call APIs with:

• Authorization: Bearer <token>

• X-Revio-Host: <your-tenant-domain>

  Tokens expire; re-exchange on 401.

Tips

• Use separate API keys per environment and per integration.
• Rotate keys; never log JWTs

Errors at a glance

Use the status code to triage quickly:

Code	Meaning	Typical next step
200/201	Success / Created	Proceed.
400	Bad Request (missing/invalid param)	Check required fields and types.
401	Unauthorized (invalid/expired token)	Re-exchange API key for JWT.
403	Forbidden (no permission)	Verify role/entitlement for the API user.
404	Not Found	Confirm resource ID/tenant.
405	Method Not Allowed	Check verb for this endpoint.
5xx	Server/temporary issue	Retry with backoff; contact support if persistent.