Search docs/

Aprovar instalação de um app

{...}

Aprovar instalação de um app de aprovação manual na comunidade especificada.

POST https://api.layers.digital/v1/appmaker/apps/{appId}/installations/{community}/approve
CopiarCopiado

Autenticação

Autenticação do tipo Token Bearer é necessária para acessar essa rota.

Parâmetros

  • community-id
    (header)
    obrigatório
    Identificador da comunidade
  • appId
    (path)
    obrigatório
    Identificador do app
  • community
    (path)
    obrigatório
    Identificador da comunidade

Resposta

Especificação

  • idStringobrigatório

    Identificador do app

  • approvalStringautomaticmanualENUMobrigatório

    Política de aprovação de instalação do app em novas comunidades

  • visibilityStringprivateunlistedpublicENUMobrigatório

    Visibilidade do app na Layers Store

  • displayNameStringobrigatório

    Nome do App que aparecerá na interface

  • descriptionStringobrigatório

    Descrição do app

  • iconObject

  • createdAtString

    Data de criação do app

  • updatedAtString

    Data da última atualização do app

  • apiObject

  • portalsObject

  • servicesObject

  • oauthObject

    Configurações de autenticação OAuth no portal

  • rolesObject

Exemplo

{
  "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": "2020-10-22T14:12:32.316Z",
  "updatedAt": "2020-10-22T14:12:32.316Z",
  "api": {
    "enabled": true,
    "roles": [
      {
        "value": "sync:manage",
        "reason": "Sincronizar dados do sistema de gestão com o Layers"
      }
    ]
  },
  "portals": {
    "enabled": true,
    "data": [
      {
        "oauth": {
          "enabled": true,
          "scopes": [
            "fullname"
          ],
          "response_type": "code",
          "grant": "authorization_code"
        },
        "origins": [
          "https://url.com.br"
        ],
        "placement": [
          "web:launchers"
        ],
        "features": [
          "exemplo"
        ],
        "alias": "@admin:settings",
        "title": "Configurações do MyApp",
        "location": "https://my-app.web.app",
        "action": "embedded",
        "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",
        "hierarchy": 5.5,
        "incudes": [
          "student",
          "post:write"
        ],
        "includedIn": [
          "student"
        ],
        "pinned": true
      }
    ]
  }
}
CopiarCopiado