Search docs/

Hub de APIs

Apps no Layers podem prover e/ou requisitar informações através do Hub de APIs por meio de actions: protocolos que especificam o formato de requisições e respostas que devem ser seguidos tanto pelo app que requisita as informações quanto pelo app que vai provê-las.

Fluxo de Informações

A troca de informações entre apps por meio do Hub de APIs pode ser descrita em quatro etapas:

  • 1 - App requisita informações

A troca de informações entre apps do Layers começa com o app que necessita de informações fazendo uma requisição POST para o Layers seguindo o padrão estabelecido pela action especificada como parâmetro na URL.

  • 2 - Layers repassa a requisição

Uma vez que o Layers recebe a requisição, o corpo é validado de acordo com o protocolo da action. Se o formato da requisição estiver de acordo com o formato especificado, o Layers repassa a requisição para o provedor especificado como parâmetro na URL adicionando informações de contexto da requisição.

  • 3 - App responde a requisição

O app provedor registrado recebe então a requisição vinda do Layers na URL especificada quando ele foi cadastrado como provedor para a action que foi requisitada. A resposta deve seguir o formato especificado pelo protocolo da action.

  • 4 - Layers repassa a resposta

Ao receber a resposta do provedor, o Layers verifica se ela está de acordo com o protocolo da action e repassa as informações recebidas para o app que as requisitou.

Actions disponíveis

A referência do Hub de APIs tem descritas todas as actions suportadas hoje pela Layers descrevendo o formato de requisição que apps provedores devem receber e qual deve ser o formato da resposta devem retornar.

Para cada uma dessas actions, está disponível um app desenvolvido pela Layers que disponibiliza essas informações. Assim, apps provedores podem se responsabilizar apenas em disponibilizar as informações e nossos apps se responsabilizam por expor essas informações da melhor maneira para os usuários da Layers.

Anterior
Portais
Próximo
Sincronização de Dados