Entendendo as APIs da Senior X

Entendendo as APIs da Senior X

As APIs da Senior X se dividem entre APIs Públicas e APIs Privadas. Elas tem os mesmos comportamentos quanto a consumo, mas tem grandes diferenças em seu ciclo de vida e disponibilidade.

Abaixo listamos as mudanças no consumo das APIs da Senior X tanto para APIs Públicas quanto para APIs Privadas.

Abaixo listamos as mudanças no consumo das APIs Públicas da Senior X

Para saber mais sobre APIs Públicas acesse APIs Públicas

Para saber mais sobre APIs Privadas acesse APIs Privadas

Alterações na URL das APIs

Essa alteração visa trazer mais simplicidade para o consumo das APIs além de padronizar as chamadas, já que torna a URL mais simples e mais amigável para o usuário.

A partir de agora, o consumo das APIs é realizado pela URL: https://api.senior.com.br adicionando apenas o dominio, serviço e primitiva

Abaixo podemos visualizar como era a chamada para a primitiva getUser do serviço de usuários da plataforma e como ela fica após a mudança

- Como era: https://platform.senior.com.br/t/senior.com.br/bridge/1.0/rest/platform/user/actions/getUser

- Como ficou: https://api.senior.com.br/platform/user/getUser

Remoção dos tipos de primitivas na URL

Outra alteração visando simplificar o consumo das APIs é a remoção dos tipos de primitivas nas chamadas das APIs. Agora não é mais necessário informar o /actions, /queries ou qualquer outro tipo na URL, bastando apenas informar o domínio/serviço/primitva.

/platform/user/getUser

OBS: As chamadas utilizando o tipo da primitiva antes da primitiva (/platform/user/actions/getUser) continuaram funcionando normalmente.

Utilização do client_id

Outra mudança no consumo das APIs é a obrigação da utilização do parâmetro client_id que deve ser passado nos headers das requisições. A partir desse parâmetro é possível monitorar as chamadas das APIs pelos clientes e parceiros. O client_id é obtido através do cadastro da aplicação.

Para saber como obter o client_id e como utilizá-lo no consumo das APIs, acesse:

- Criando uma Aplicação

- Consumindo uma API