You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 7, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: src/pages/api/apihub.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -6,12 +6,12 @@ tableOfContents: false
6
6
7
7
# Layers API Hub
8
8
9
-
O Layers API Hub é uma funcionalidade do ecossistema Layers que permite Apps consumirem e fornecerem informações de outros Apps na Layers. Isto é feito através de actions: um protocolo que especifica o formato de comunicação entre os consumidores e fornecedores de informação.
9
+
O Layers API Hub é uma funcionalidade do ecossistema Layers que permite Apps consumirem e fornecerem informações de outros Apps na Layers. Isto é feito através de actions: um protocolo que especifica o formato de comunicação entre os consumidores e Provedores de informação.
10
10
11
-
Para cada uma dessas actions, está disponível ao menos um App desenvolvido pela Layers que disponibiliza essas informações. Assim, Apps fornecedores podem se responsabilizar apenas em fornecer as informações requisitadas via actions e outros Apps consumidores se responsabilizam por expor essas informações da melhor maneira para os usuários da Layers.
11
+
Para cada uma dessas actions, está disponível ao menos um App desenvolvido pela Layers que disponibiliza essas informações. Assim, Apps Provedores podem se responsabilizar apenas em fornecer as informações requisitadas via actions e outros Apps consumidores se responsabilizam por expor essas informações da melhor maneira para os usuários da Layers.
12
12
13
13
Para exemplificar, observe:
14
-
<docs-zoomable-imagehref="/docs/assets/images/flow-erp.png"caption="O app mais a esquerda é o “Notas Acadêmicas” e irá representar apps que necessitam de requisitar dados (App consumidor). Já o app mais a direita é o “ERP Modelo” e irá representar os apps que podem prover dados para outros apps (App fornecedor)."></docs-zoomable-image>
14
+
<docs-zoomable-imagehref="/docs/assets/images/flow-erp.png"caption="O app mais a esquerda é o “Notas Acadêmicas” e irá representar apps que necessitam de requisitar dados (App consumidor). Já o app mais a direita é o “ERP Modelo” e irá representar os apps que podem prover dados para outros apps (App Provedor)."></docs-zoomable-image>
@@ -20,12 +20,12 @@ O App Consumidor irá fazer uma requisição HTTP (POST) para a Layers, requisit
20
20
21
21
+ <strong> 2 - Layers repassa a requisição </strong>
22
22
23
-
A Layers irá requisitar os dados do App Fornecedor. Este último deve receber os dados como especificados na nossa documentação. Além de fazer a requisição para o App Fornecedor, a Layers irá enriquecer os dados enviados adicionando contexto (context) a eles.
23
+
A Layers irá requisitar os dados do App Provedor. Este último deve receber os dados como especificados na nossa documentação. Além de fazer a requisição para o App Provedor, a Layers irá enriquecer os dados enviados adicionando contexto (context) a eles.
24
24
25
25
+ <strong> 3 - App responde a requisição </strong>
26
26
27
-
Após receber os dados, o App Fornecedor irá requisitar os dados armazenados pelo ERP (nesse caso), realizando outra requisição HTTP (POST), e retornar os dados para Layers. Novamente, seu formato de response deve seguir o que está especificado na documentação da action específica.
27
+
Após receber os dados, o App Provedor irá requisitar os dados armazenados pelo ERP (nesse caso), realizando outra requisição HTTP (POST), e retornar os dados para Layers. Novamente, seu formato de response deve seguir o que está especificado na documentação da action específica.
28
28
29
29
+ <strong> 4 - Layers repassa a resposta </strong>
30
30
31
-
Ao final, a Layers recebe os dados do App Fornecedor e valida-os para verificar se estão de acordo com o que era esperado como resposta da action. Caso estejam corretos, eles são repassados para o App Consumidor, assim podendo utilizá-los.
31
+
Ao final, a Layers recebe os dados do App Provedor e valida-os para verificar se estão de acordo com o que era esperado como resposta da action. Caso estejam corretos, eles são repassados para o App Consumidor, assim podendo utilizá-los.
Copy file name to clipboardExpand all lines: src/pages/api/apihub/consumindo.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -4,17 +4,17 @@ title: Consumindo uma Action
4
4
tableOfContents: false
5
5
previousText: 'Introdução'
6
6
previousUrl: '/docs/api/apihub'
7
-
nextText: 'Fornecendo Informações'
8
-
nextUrl: '/docs/api/apihub/fornecendo'
7
+
nextText: 'Provendo Informações'
8
+
nextUrl: '/docs/api/apihub/provendo'
9
9
---
10
10
11
11
# Consumindo uma Action
12
12
13
-
Dada uma certa Action, antes de consumí-la, é preciso que seu App Consumidor descubra quais são os Apps Provedores disponíveis para essa Action. Após isso, é preciso que seu app requisite para cada um dos fornecedores as informações da action específica.
13
+
Dada uma certa Action, antes de consumí-la, é preciso que seu App Consumidor descubra quais são os Apps Provedores disponíveis para essa Action. Após isso, é preciso que seu app requisite para cada um dos Provedores as informações da action específica.
14
14
15
15
Para descobrir os Apps Provedores da Action, basta rodar a seguinte requisição:
Para um App Consumidor poder consumir dados de uma action é necessário que haja um app responsável por prover dados para essa Action. Um app com essa responsabilidade é chamado de App Provedor. Um exemplo comum desse tipo são ERPs que fornecem diversos dados como notas acadêmicas, registros médicos e etc, que podem ser utilizados por outros apps.
12
+
13
+
## Respondendo por uma Action
14
+
15
+
### Request
16
+
17
+
Para um App Provedor ser responsável por determinada action, é necessário que sejam implementadas rotas do tipo
18
+
19
+
```http
20
+
POST https://api.layers.digital/v1/services/validate/{{action}}/{{provider_id}}
21
+
```
22
+
23
+
```headers
24
+
Authorization: Bearer {{token_do_seu_app}}
25
+
community-id: {{id_da_comunidade}}
26
+
```
27
+
28
+
Ou seja, para cada Action que um app é responsável por fornecer dados, é necessário que haja uma rota que responda por ela conforme especificado anteriormente.
29
+
30
+
### Response
31
+
32
+
A payload da resposta da requisição varia de acordo com a Action.
Comunidades são a maior unidade de organização na Layers. Cada instituição de ensino, desenvolvedor de app ou fornecedor é representada por uma comunidade na Layers que contém seus dados e na qual são instalados os apps que adicionarão funcionalidades escolhidas pelos administradores da comunidade.
13
+
Comunidades são a maior unidade de organização na Layers. Cada instituição de ensino, desenvolvedor de app ou Provedor é representada por uma comunidade na Layers que contém seus dados e na qual são instalados os apps que adicionarão funcionalidades escolhidas pelos administradores da comunidade.
14
14
15
-
Além da personalização por meio dos apps, é possível escolher também o ícone, nome e modelo de comunidade que melhor se aplica ao cenário no qual ela vai ser utilizada (escolar, desenvolvedor de apps, fornecedor, torneio, etc).
15
+
Além da personalização por meio dos apps, é possível escolher também o ícone, nome e modelo de comunidade que melhor se aplica ao cenário no qual ela vai ser utilizada (escolar, desenvolvedor de apps, Provedor, torneio, etc).
16
16
17
17
Para instituições com várias unidades é possível ainda definir a hierarquia de suas comunidades, definindo a comunidade da mantenedora ou sede como pai das comunidades das demais unidades. Desse modo, usuários da comunidade pai podem acessar as comunidades filhas e enviar publicações para elas.
0 commit comments