Skip to main content
Every account has a personal securityToken. Find it in the panel under My Settings → API access (/opcoes). Treat it like a password — it grants full access to your account’s orders and credits. There are two authentication styles depending on the product.

API token (Letters, E-mail, Receipts)

The core letter and e-mail routes take the token in the URL path (read routes) or as the userSecurityToken form field (create routes). The securityToken header and Authorization: Bearer forms work on the logo and receipts endpoints.
For POST endpoints (e.g. creating an order or e-mail) send userSecurityToken as a form field in the request body. It is also accepted as a query parameter wherever the header forms work.

HTTP Basic (WhatsApp)

The WhatsApp endpoints use HTTP Basic Auth, where the username is your account e-mail and the password is your securityToken.

Errors

See Errors for the full envelope shapes.