Skip to content
This repository was archived by the owner on Aug 7, 2023. It is now read-only.

Commit c03b792

Browse files
committed
fornecedores -> provedores; fornecendo page; new separation in Providing
1 parent 46c62be commit c03b792

File tree

8 files changed

+57
-24
lines changed

8 files changed

+57
-24
lines changed

src/components/menu/templates/api.tsx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@ export default () => {
55
return <docs-nav items={items} />
66
};
77

8+
const requests = Object.values(menuData.apihub).flat()
9+
810
const items = {
911
'API Hub': {
1012
'Introdução': '/docs/api/apihub',
1113
'Consumindo dados de uma Action': '/docs/api/apihub/consumindo',
12-
'Fornecendo dados para uma Action': '/docs/api/apihub/fornecendo'
14+
'Provendo dados para uma Action': '/docs/api/apihub/provendo'
1315
},
14-
...(menuData.apihub)
16+
'Provendo Dados': requests
1517
}

src/components/menu/templates/concepts.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ const items = {
1313
},
1414

1515
// 'Pensado para EdTechs': {
16-
// // 'Fornecedores': '/docs/concepts/fornecedores',
16+
// // 'Provedores': '/docs/concepts/Provedores',
1717
// },
1818

1919
// 'Funcionalidades': {

src/pages/api/apihub.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ tableOfContents: false
66

77
# Layers API Hub
88

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.
1010

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.
1212

1313
Para exemplificar, observe:
14-
<docs-zoomable-image href="/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-image href="/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>
1515
## Como funciona ?
1616

1717
+ <strong> 1 - App requisita informações </strong>
@@ -20,12 +20,12 @@ O App Consumidor irá fazer uma requisição HTTP (POST) para a Layers, requisit
2020

2121
+ <strong> 2 - Layers repassa a requisição </strong>
2222

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.
2424

2525
+ <strong> 3 - App responde a requisição </strong>
2626

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.
2828

2929
+ <strong> 4 - Layers repassa a resposta </strong>
3030

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.

src/pages/api/apihub/consumindo.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ title: Consumindo uma Action
44
tableOfContents: false
55
previousText: 'Introdução'
66
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'
99
---
1010

1111
# Consumindo uma Action
1212

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.
1414

1515
Para descobrir os Apps Provedores da Action, basta rodar a seguinte requisição:
1616

17-
## Descobrindo os Apps Fornecedores
17+
## Descobrindo os Apps Provedores
1818

1919
### Request
2020

@@ -50,19 +50,19 @@ community-id: {{id_da_comunidade}}
5050
]
5151
```
5252

53-
A partir dessa resposta, precisamos, para cada App Fornecedor, requisitar seus dados referentes a action específica.
53+
A partir dessa resposta, precisamos, para cada App Provedor, requisitar seus dados referentes a action específica.
5454

55-
## Requisitando Informações para um App Fornecedor específico
55+
## Requisitando Informações para um App Provedor específico
5656

5757
### Request
5858

5959
```http
60-
GET https://api.layers.digital/v1/services/call/{{action}}/{{id_app_fornecedor}}?version={{versao_da_action_desejada}}
60+
GET https://api.layers.digital/v1/services/call/{{action}}/{{id_app_Provedor}}?version={{versao_da_action_desejada}}
6161
```
6262

6363
```headers
6464
Authorization: Bearer {{token_do_seu_app}}
6565
community-id: {{id_da_comunidade}}
6666
```
6767

68-
O corpo da mensagem varia de acordo com a action, assim como o payload de resposta. Você pode checar com detalhes nas seções logo abaixo! :)
68+
O corpo da requisição varia de acordo com a action, assim como o payload de resposta. Você pode checar com detalhes nas seções logo abaixo! :)

src/pages/api/apihub/fornecendo.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
template: default
3+
title: Provendos dados para uma Action
4+
tableOfContents: false
5+
previousText: 'Consumindo Informações'
6+
previousUrl: '/docs/api/apihub/consumindo'
7+
---
8+
9+
# Provendo dados para uma Action
10+
11+
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.

src/pages/concepts/ecossistema-layers/comunidades.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ previousUrl: '/docs/concepts/ecossistema-layers'
1010

1111
# Comunidades na Layers
1212

13-
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.
1414

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).
1616

1717
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.

src/pages/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Para desenvolvedores desses serviços, integrar sua solução à Layers signific
2222
<p>Funcionalidades para Sistemas de Gestão</p>
2323
</docs-card>
2424

25-
<!-- <docs-card header="fornecedores" href="/docs/concepts/fornecedores" icon="/docs/assets/icons/Fornecedores.svg">
26-
<p>Funcionalidades para fornecedores</p>
25+
<!-- <docs-card header="Provedores" href="/docs/concepts/Provedores" icon="/docs/assets/icons/Provedores.svg">
26+
<p>Funcionalidades para Provedores</p>
2727
</docs-card> -->
2828
</docs-cards>

tsconfig.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
"experimentalDecorators": true,
77
"lib": [
88
"dom",
9-
"es2017"
9+
"es2019"
1010
],
1111
"moduleResolution": "node",
1212
"module": "esnext",
13-
"target": "es2017",
13+
"target": "es2019",
1414
"noUnusedLocals": true,
1515
"noUnusedParameters": true,
1616
"resolveJsonModule": true,
@@ -28,4 +28,3 @@
2828
"node_modules"
2929
]
3030
}
31-

0 commit comments

Comments
 (0)