Developer Center
Pesquisar K

Appearance

Atualizar Instalação​

PUT
/v1/appmaker/apps/{appId}/installations/{community}

Atualizar instalação de um app na comunidade especificada

Autorizações​

Bearer

Generate a token

TipoHTTP (bearer)

Parâmetros​

Parâmetros de Cabeçalho

community-id*

Identificador da comunidade

Tipostring
Obrigatório
Exemplo"test"

Parâmetros de Caminho

community*

Identificador da comunidade

Tipostring
Obrigatório
Exemplo"test"
appId*

Identificador do app

Tipostring
Obrigatório
Exemplo"test"

Corpo da Requisição​

application/json
JSON
{
"manifest": {
"id": "appid",
"approval": "automatic",
"visibility": "public",
"displayName": "My App",
"description": "App que adiciona funcionalidades ao Layers",
"icon": {
"url": "www.url.com",
"width": 1024,
"height": 1024
},
"createdAt": "string",
"updatedAt": "string",
"api": {
"enabled": true,
"roles": [
{
"value": "sync:manage",
"reason": "Sincronizar dados do sistema de gestão com a Layers"
}
]
},
"portals": {
"enabled": true,
"data": [
{
"oauth": {
"enabled": true,
"scopes": [
"fullname"
],
"response_type": "code",
"grant": "authorization_code"
},
"origins": [
"https://url.com.br"
],
"placement": [
"string"
],
"features": [
"string"
],
"alias": "@admin:settings",
"title": "Configurações do MyApp",
"location": "https://my-app.web.app",
"action": "string",
"icon": "https://urlDoIcone.com"
}
]
},
"services": {
"enabled": true,
"requests": [
{
"action": "@layers:payments:Payables:getRelated",
"reason": "Precisamos chamar está action para consumir dados de outros apps que sejam capaz de export dados financeiros"
}
],
"responds": [
{
"action": "@layers:payments:Payables:getRelated",
"reason": "Prover informações financeiras do ERP",
"url": "https://myapi.com/v1/financeiro"
}
]
},
"oauth": {
"enabled": true,
"scopes": [
"fullname"
],
"response_type": "code",
"grant": "authorization_code"
},
"roles": {
"enabled": true,
"data": [
{
"title": "Aluno monitor",
"value": "student:monitor",
"group": "Geral",
"incudes": [
[
"student"
]
],
"includedIn": [
[
"student"
]
],
"pinned": true
}
]
}
},
"approved": true,
"approvedAt": "string",
"approvedBy": "string",
"active": true,
"activatedAt": "string",
"installed": true,
"installedBy": true,
"uninstalledAt": "string",
"uninstalledBy": "string",
"uninstalledReason": "mudança de ERP",
"pendingUpdate": false,
"pendingUpdateSince": "string",
"requiresManualUpdate": false,
"status": "pending_approval",
"consentedFeatures": [
{
"id": "api:group:read",
"consentedAt": "string"
}
],
"contactInfo": {
"name": "Responsável pelo app",
"telephone": "(11)99999-9999",
"message": "Caso tenha qualquer dúvida, entre em contato por telefone ou whatsapp!"
}
}

Respostas​

Instalação do app

application/json
JSON
{
"manifest": {
"id": "appid",
"approval": "automatic",
"visibility": "public",
"displayName": "My App",
"description": "App que adiciona funcionalidades ao Layers",
"icon": {
"url": "www.url.com",
"width": 1024,
"height": 1024
},
"createdAt": "string",
"updatedAt": "string",
"api": {
"enabled": true,
"roles": [
{
"value": "sync:manage",
"reason": "Sincronizar dados do sistema de gestão com a Layers"
}
]
},
"portals": {
"enabled": true,
"data": [
{
"oauth": {
"enabled": true,
"scopes": [
"fullname"
],
"response_type": "code",
"grant": "authorization_code"
},
"origins": [
"https://url.com.br"
],
"placement": [
"string"
],
"features": [
"string"
],
"alias": "@admin:settings",
"title": "Configurações do MyApp",
"location": "https://my-app.web.app",
"action": "string",
"icon": "https://urlDoIcone.com"
}
]
},
"services": {
"enabled": true,
"requests": [
{
"action": "@layers:payments:Payables:getRelated",
"reason": "Precisamos chamar está action para consumir dados de outros apps que sejam capaz de export dados financeiros"
}
],
"responds": [
{
"action": "@layers:payments:Payables:getRelated",
"reason": "Prover informações financeiras do ERP",
"url": "https://myapi.com/v1/financeiro"
}
]
},
"oauth": {
"enabled": true,
"scopes": [
"fullname"
],
"response_type": "code",
"grant": "authorization_code"
},
"roles": {
"enabled": true,
"data": [
{
"title": "Aluno monitor",
"value": "student:monitor",
"group": "Geral",
"incudes": [
[
"student"
]
],
"includedIn": [
[
"student"
]
],
"pinned": true
}
]
}
},
"approved": true,
"approvedAt": "string",
"approvedBy": "string",
"active": true,
"activatedAt": "string",
"installed": true,
"installedBy": true,
"uninstalledAt": "string",
"uninstalledBy": "string",
"uninstalledReason": "mudança de ERP",
"pendingUpdate": false,
"pendingUpdateSince": "string",
"requiresManualUpdate": false,
"status": "pending_approval",
"consentedFeatures": [
{
"id": "api:group:read",
"consentedAt": "string"
}
],
"contactInfo": {
"name": "Responsável pelo app",
"telephone": "(11)99999-9999",
"message": "Caso tenha qualquer dúvida, entre em contato por telefone ou whatsapp!"
}
}

Exemplos​

cURL
JavaScript
PHP
Python