Skip to content
platform

Get started

Environments and base URL

Base URL

Every endpoint in the reference starts from the base URL below, the one the public collection ships in its url variable.

The collection tells you to set the url variable to the environment you are going to use. An integration project starts with a sandbox environment and credentials, requested by email from API support. The sandbox address is not published in the collection: it arrives with the credentials.

https://ws.autorei.net

The collection in Postman

The public collection is the official source of this reference. The CWS Platform technology team updates the collection, and the pages on this site are generated from a versioned copy of it.

In the collection, the token request stores the access_token in a variable and every other request inherits the authorization header. On each endpoint page, the Test in Postman button opens the same request in the public documentation.

The two call directions

The integration runs in two directions, and they are documented differently.

  • From your system to CWS Platform: the calls in the API reference, authenticated with the platform token.
  • From CWS Platform to your system: synchronous callbacks and asynchronous webhooks. Here the endpoint is yours, and the reference describes what the platform sends and what it expects back.

Integration support

Questions about environments, credentials and webhook setup go to the channel published in the collection: suporte-api@cws.digital.

Get started

  • Authentication: One token for 12 hours, sent as Bearer on every call.
  • Pagination and limits: limit and offset, per-endpoint caps and the two batch routes.
  • Errors: The five codes, the two body formats and the partial 200.

Generated from the public API collection, published on 2026-09-04: api-docs.cws.digital.