Acesso via API
  • 11 May 2023
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Acesso via API

  • Dark
    Light

Article summary

Acesso via API

Para acessar o sistema através da api é necessário um token de acesso. Esse token só pode ser gerado pelo usuário principal da conta (usuários do tipo "Dependente" não têm permissão para gerar e/ou visualizar o token).

Para gerar o token de acesso basta navegar até "Configurações do sistema" e clicar na aba "Token de accesso ao Cfazmax". O token é uma hash como esta: 0cd675768fev8dab81fe1c1297d56b09.

O token pode ser usado de duas formas para autenticar uma requisição:

Como um HTTP Token authentication no header da requisição:
Authorization: Token 0cd675768fev8dab81fe1c1297d56b09
Na URL, como o parâmetro "access_token":

https://max.cfaz.net/api/v1/controller/action?access_token=0cd675768fev8dab81fe1c1297d56b09

Se por algum motivo for necessário trocar o token, é possível fazê-lo isso clicando no botão "Gerar novo token". O novo token será gerado e o token anterior deixará de funcionar.

Também é possível acessar a API utilizando o email e senha do usuário em vez do token de acesso. Isso é util ao utilizar a API para mostrar informações de dentistas, pois eles não possuem token de acesso. Para resuisitar um token de acesso utilizando email e senha use o comando:

curl -i -X POST \
     -d "email=dentista@ri5.com.br" \
     -d "password=cfazri5" \
     https://max.cfaz.net/api/v1/auth/sign_in

Utilize as informações no cabeçalho de access-token, token-type, client, expiry e uid para fazer as proximas requisições, como por exemplo:

curl -i \
     -H "token-type: Bearer" \
     -H "access-token: xxxxx" \
     -H "client: xxxxx" \
     -H "uid: xxxxx" \
     -H "expiry: xxxxx" \
     https://max.cfaz.net/api/v1/requests?per_page=10

What's Next