Primeiros passos

Cadastro no portal

Para acessar o todo o conteudo você precisa se cadastrar no portal. É rápido e fácil.



Criação de app

Após realizar seu cadastro, você precisará criar uma app. Para isso, acesse a página "MINHAS APPS", dentro do menu "DEV TOOLS":



Em seguida basta clicar no botão cadastrar nova app e informar o nome e uma descrição. Selecione quais apis sua app irá acessar e pronto, sua app foi criada. Caso queira, você também pode adicionar uma imagem para sua app.



Após a criação desta APP, você receberá o par de chaves (client_id e client_secret), que o permitirão através do processo de OAuth obter tokens para consumo das APIs. Essas APPs criadas terão acesso automático ao ambiente disponibilizado por este portal, onde encontram-se os mocks de todas as APIs disponíveis. Então a partir deste momento, você já será capaz de consumir todas as APIs através de chamadas simples via portal ou via client (código próprio), usando as credenciais da APP criada, no ambiente dos mocks.



Consumindo uma API

OAuth 2.0 - Gerando o token

Com a sua app em mãos, você precisará agora criar seu token para começar a usar as APIs.

Criando seu token

Para gerar o token, iremos utilizar o processo de Authorization Code do OAuth. Caso você queira saber mais sobre OAuth, acesse o site

Com sua app criada, o primeiro passo é gerar seu grant-code, um código temporário que você irá utilizar na geração do token. Abaixo iremos detalhar o passo-a-passo de como obter o token. Você pode fazer o processo via postman, ou diretamente em nosso portal, através do swagger da API, acessando a API de OAuth, lá você encontrará todas as informações necessárias referentes aos tipos campos e metódos utilizados.

Para gerar o seu grant-code, você precisará acessar esta operação no swagger, ou o realizar a chamada diretamente no endpoint abaixo, via POST:

https://api-athenasaude.sensedia.com/sandbox/oauth/grant-code

No cabeçalho, você deverá passar a seguinte informação:

Header => Content-Type : application/json

No corpo, devemos enviar os seguintes itens:

{ "client_id": "f9212173-e764-373b-a698-61923e378359", "redirect_uri": "string" }

Obs1: A descrição e tipo de cada um deles está na documentação da API de oauth do dev portal
Obs2: O clientId a ser passado deve ser o mesmo da APP criada.

Feito isso, espera-se uma resposta com um “authorization code”, conforme abaixo:

{ "redirect_uri": "string?code=8748d39f-1d4f-311f-92c6-4b279db1b317" }

Feito esse processo, você agora possui seu grant-code, ou Authorization code. Ele é temporário e só poderá ser utilizado uma vez. O proximo passo agora é obter um access_token. Caso você esteja utilizando nosso swagger do portal, você acessará esta operação. Você pode também realizar a chamada diretamente no endpoint abaixo, via POST:

https://api-athenasaude.sensedia.com/sandbox/oauth/access-token

No cabeçalho você deverá passar a seguinte informação:

Header => Authorization : Basic client_id:client_secret

OBS.: Este client_id:client_secret deve ser uma string convertida em Base64, usando os dados da APP criada.



O exemplo do cabeçalho com o client_id e secret convertidos para base64, seria:

Authorization : Basic ZjkyMTIxNzMtZTcwNS0zNzNiLWE2OTgtNjE5MjNlMzc4MzU5OjAyYWI1Mjg4LTkyZGItM2FiMy05OWZkLWZhYzRhZjg1N2Q4MQ==

No corpo, devemos passar o “authorization code” gerado pelo endpoint anterior, com mais alguns itens, no formato x-www-form-urlencoded:

"grant_type": "authorization_code" "code" : "8748d39f-1d4f-311f-92c6-4b279db1b317"

Por fim, o Access Token será gerado e retornará um json conforme a estrutura abaixo:

{ "access_token": "57f10f0e-3d2e-311f-a797-4011f66e1cbf", "refresh_token": "ca81cb16-43e4-3e96-aaea-4861e7791dc7", "token_type": "access_token", "expires_in": 3600 }

OAuth 2.0 - Refresh Token

O Refresh Token será utilizado para criar um novo access_token que foi expirado. Para isso, basta seguir os passos abaixo:

Caso você esteja utilizando nosso swagger do portal, você acessará esta operação. Você pode também realizar a chamada diretamente no endpoint abaixo, via POST:

https://api-athenasaude.sensedia.com/sandbox/oauth/access-token

No cabeçalho você deverá passar a seguinte informação:

Header => Authorization : Basic client_id:client_secret

OBS.: Este client_id:client_secret deve ser uma string convertida em Base64, usando os dados da APP criada.



O exemplo do cabeçalho com o client_id e secret convertidos para base64, seria:

Authorization : Basic ZjkyMTIxNzMtZTcwNS0zNzNiLWE2OTgtNjE5MjNlMzc4MzU5OjAyYWI1Mjg4LTkyZGItM2FiMy05OWZkLWZhYzRhZjg1N2Q4MQ==

No corpo, devemos passar o “refresh_token” gerado pelo endpoint anterior, com mais alguns itens, no formato x-www-form-urlencoded:

"grant_type": "refresh_token" "refresh_token" : "ca81cb16-43e4-3e96-aaea-4861e7791dc7"

Por fim, o Access Token será gerado novamente e retornará um json conforme a estrutura abaixo:

{ "access_token": "57f10f0e-3d2e-311f-a797-4011f66e1cbf", "refresh_token": "ca81cb16-43e4-3e96-aaea-4861e7791dc7", "token_type": "access_token", "expires_in": 3600 }

Status Codes

Código Erro Descrição
200 OK

Sucesso.
400 Bad Request

A requisição possui parametro(s) inválido(s).
401 Unauthorized

O token de acesso não foi informado ou não possui acesso as APIs.
404 Not Found

O recurso informado no request não foi encontrado.
413 Request is to Large

A requisição está ultrapassando o limite permitido para o perfil do seu token de acesso.
422 Unprocessable Entity

A requisição possui erros de negócio.
429 Too Many Requests

O consumidor estourou o limite de requisições por tempo.
500 Internal Server Error

Erro não esperado, algo está quebrado na API.

Processo de Parceria

Após o cadastro no portal e a criação da sua app, você terá acesso ao ambiente de sandbox.

Caso deseje se tornar um parceiro, você deverá solicitar acesso aos demais ambientes, realizando o procedimento abaixo:

Já logado, abra um chamado neste portal. Clique em SUPORTE no canto superior da página.



Neste cartão, informe o nome da sua APP, o client_id da sua APP e o ambiente que deseja que esta APP tenha acesso (Homologação / Produção). Salve seu ticket e aguarde até que um dos representantes avalie seu pedido. Você será contactado por email, o mesmo informado em seu cadastro. Caso seu pedido seja aceito, sua APP estará apta a acessar o ambiente solicitado.



Termos de Uso

Português, Brasil