Connect your systems to your Auvo operation data.

• Simple and predictable REST

  Endpoints organized by domain, consistent HTTP verbs and stable response envelopes.

• Bearer JWT authentication

  30-minute token via POST /login. Easy to rotate, easy to revoke. Sandbox is on the roadmap.

• 400 req/min per IP

  Clear rate limit with status 403 and standardized JSON payload. Use pagination + backoff.

• Native webhooks

  Subscribe to task, ticket and service-order events through authenticated POST calls to your URL.

• Multi-language examples

  curl, Node.js, PHP, Python and Go in each operation - copy, run and adapt.

• Weekly changelog

  Every relevant change lands in the changelog before production, with deprecations flagged 90 days ahead.

1. 1

   Get credentials

   In Menu > Integration, copy apiKey and apiToken. Keep them in a secret manager.

2. 2

   Authenticate and receive the token

   Exchange apiKey + apiToken for an accessToken (30-minute JWT).

   curlJavaScriptNode.jsPythonJavaC#PHPGoRuby

   Copiar

   curl -X POST https://api.auvo.com.br/v2/login \
     -H 'Content-Type: application/json' \
     -d '{"apiKey":"<YOUR_KEY>","apiToken":"<YOUR_TOKEN>"}'

3. 3

   Make the first authenticated call

   List users with pagination.

   curlJavaScriptNode.jsPythonJavaC#PHPGoRuby

   Copiar

   curl 'https://api.auvo.com.br/v2/users?page=1&pageSize=20' \
     -H "Authorization: Bearer $AUVO_TOKEN"

Common use cases

• Authentication

  Login flow, token rotation and secret management best practices.

• Pagination

  pageInformation envelope, limits and emulated cursor strategies.

• Rate limit

  400 req/min, response headers and recommended exponential backoff.

• Webhooks

  Subscription, payloads, retries and origin validation.

• Errors

  HTTP codes, error payload, idempotency and troubleshooting.

• Versioning

  Breaking-change policy, deprecations and notification channel.