Acesso à API — Solicitação de Credenciais
Olá! 👋
Antes de iniciar sua integração com a API da Sistematize, é necessário obter suas credenciais de acesso (usuário de autenticação).
Para isso, envie uma solicitação para o nosso time de tecnologia através do e-mail:
📩 [email protected]
No corpo do e-mail, recomendamos informar:
- Nome da empresa
- Responsável técnico (nome e contato)
- Ambiente desejado (homologação ou produção)
Assim que receber suas credenciais, você poderá seguir com a autenticação e o consumo dos nossos endpoints.
Importante: As credenciais são pessoais e intransferíveis. Guarde com segurança e não compartilhe com terceiros.
Autenticação — Basic Authentication
Todas as requisições à API da Sistematize exigem o uso de Basic Authentication ou como a maioria conhece Basic Auth, que serve para garantir a segurança da comunicação.
Como funciona a autenticação:
Para fazer a autenticação do basic auth, primeiro precisa validar seu usuário. Para validar o usuário, deve verificar o tipo de usuário que está usando, sendo eles tipo USUÁRIO e o tipo APLICAÇÃO. A diferença esta na primeira autenticação e também que o tipo usuário pode acessar nosso portal do lojista, já o tipo aplicação não pode.
| ROTA AUTENTICAÇÃO |
|---|
https://sandbox.sistematize.me:8443/api/v1/usuario/autenticacao |
Primeira Autenticação com o tipo Usuário:
{
"email":"[email protected]",
"senha":"suasenhaaqui",
"codigo_2fa_telefone":"codigo_sms"
}
Primeira Autenticação com o tipo Aplicação:
{
"email":"[email protected]",
"senha":"suasenhaaqui"
}
Após realizar a autenticação com o seu usuário, terá o retorno de um Json. Nesse Json retornará algumas informações do seu usuário e também o token, vai precisar pegar este token para fazer o basic auth da sua requisição.
{
"id": "String",
"codigo": 93,
"status": "String",
"tipo": "String",
"nome": "String",
"cpf": "String",
"email": "String",
"telefone": "String",
"token": "TOKEN_USUARIO",
"data_validade_token": "String",
"data_atualizacao": "String",
"marketplace": {
"id": "UUID"
},
"permissoes": {
"extrato_conta": boolean,
"adm_servico": boolean,
"cancelar_cobranca": boolean,
"adm_usuario": boolean,
"receber_credito": boolean,
"alterar_valor_item": boolean,
"fechamento_caixa": boolean,
"flash_caixa": boolean,
"reforco_caixa": boolean,
"adm_cliente": boolean,
"sangria_caixa": boolean,
"adm_empresa": boolean,
"receber_pix": boolean,
"adm_plano": boolean,
"adm_split": boolean,
"cancelar_nfs": boolean,
"receber_dinheiro": boolean,
"receber_boleto": boolean,
"adm_cobranca": boolean,
"abertura_caixa": boolean,
"cancelar_transacao": boolean,
"emissao_nfs": boolean,
"receber_debito": boolean
},
"max_desconto": 100.00
}
Gerando Hmac_Sha1 para Assinatura das Requisições:
Após a autenticação bem-sucedida, cada requisição à API deve ser assinada com um HMAC-SHA1, garantindo a integridade e autenticidade dos dados enviados.
Se a chamada for do tipo POST, a assinatura deve ser gerada utilizando o corpo (body) da requisição como base.
Se a chamada for do tipo GET, a assinatura deve ser gerada utilizando a url (endpoint) da requisição como base.
Site do Sha1 - https://codebeautify.org/hmac-generator
Após gerar a assinatura que será um token, deve pegar esse token e informar ele da seguinte forma:
Pode colocar em Authorization a opção Basic Auth. Na parte username (usuario), deve informar o e-mail que realizou o login. Na parte de password (senha), deve informar sha1=ASSINATURA_SHA1_GERADA. A assinatura ASSINATURA_SHA1_GERADA é a assinatura (token) que você gerou mais acima.
Após esse processo, pode fazer a requisição que terá um 200 (sucesso), no retorno.
Ambientes
| AMBIENTE | ENDEREÇO |
|---|---|
| PRODUÇÃO | https://app.sistematize.me:8443/api/v1 |
| SANDBOX | https://sandbox.sistematize.me:8443/api/v1 |
Lembrando que nossa API é RESTful, todas as respostas são em JSON.