API Reference

De que forma a Sistematize identifica quem é você ?

Olá! Antes de começar sua integração com a nossa API é necessário solicitar as suas credenciais ao Departamento de Tecnologia da Sistematize. Para realizar esta solicitação, será através do endereço de e-mail [email protected].

🚧

Atenção :

  • Seu usuário e token carregam muitos privilégios. Portanto certifique-se de mantê-los protegidos, não informe eles em atendimentos, e não exponha no front-end da sua aplicação.
  • Caso perca seu usuário e senha, não será possível recuperá-los. Sendo assim, será nescessário a criação de outro usuário e senha.

A cada requisição feita, é necessário fornecer Basic Autentication. O nome de usuário a ser utilizado na requisição é fornecido pela equipe da Sistematize. Quanto à senha do basic auth, ela deve ser um token gerado de acordo com as instruções a seguir:


📑

Para começar, é necessário gerar um HMAC_SHA1 com o token obtido na rota de autenticação do usuário.


Para as requisições Sem body como por exemplo:

GET ou DELETE.
O HMAC_SHA1 deve ser gerado a partir da URL completa da requisição, incluindo os parâmetros que serão passados na própria URL.

Para as requisições com Body como por exemplo :

POST ou PUT.
Deve-se gerar um HMAC_SHA1 do Raw Body utilizando o token obtido durante o processo de autenticação.

O resultado será:

O Hash gerado pelo algoritmo HMAC_SHA1, deve ser incluído no campo de senha (password) Basic Autentication.

▶️ Exemplo :

Suponha que o token fornecido utilize a senha "1234" para o conteúdo "Teste HMAC".

O resultado é um Hash.

Aqui está um exemplo de um Hash fictício:

sha1=ef65ab5d7fe85c5e03703e6e41d5b39ebac9a08b

Lembre-se de preceder o Hash com sha1= antes de enviá-lo para garantir que ele seja transmitido corretamente.

📘

Nota

A autenticação no ambiente de sandbox é opcional. No entanto, recomendamos que você faça testes preliminares para entender melhor o funcionamento da nossa API e para adquirir um conhecimento básico sobre a Sistematize.

📘

Deseja verificar se sua autenticação está correta ?

Deve apenas informar o Authorization no header da requisição