Ambientes e URL base

URL base

Todos os endpoints da referência partem da URL base abaixo, que é a que a coleção pública traz na variável url.

A coleção orienta a ajustar a variável url para o ambiente que você vai usar. Um projeto de integração começa com um ambiente de sandbox e credenciais de uso, solicitados por e-mail ao suporte da API. O endereço do sandbox não é publicado na coleção: ele chega junto com as credenciais.

https://ws.autorei.net

A coleção no Postman

A coleção pública é a fonte oficial desta referência. O time de tecnologia da CWS Platform atualiza a coleção, e as páginas deste site são geradas a partir de uma cópia versionada dela.

Na coleção, a requisição de token grava o access_token em variável e as demais requisições herdam o header de autorização. Em cada página de endpoint, o botão Testar no Postman abre a mesma requisição na documentação pública.

Os dois sentidos de chamada

A integração tem dois sentidos, e eles são documentados de forma diferente.

• Do seu sistema para a CWS Platform: as chamadas da referência da API, autenticadas com o token da plataforma.
• Da CWS Platform para o seu sistema: callbacks síncronos e webhooks assíncronos. Aqui o endpoint é seu, e a referência descreve o que a plataforma envia e o que espera de volta.

Suporte à integração

Dúvidas sobre ambiente, credenciais e configuração de webhooks vão para o canal que a coleção publica: suporte-api@cws.digital.