Search docs/

Ver Instalações

{...}

Ver instalações ativas de um app

GET https://api.layers.digital/v1/appmaker/apps/{appId}/installations
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

Resposta

Especificação

Exemplo

[
  {
    "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": "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
          }
        ]
      }
    },
    "approved": true,
    "approvedAt": "2020-10-22T14:12:32.316Z",
    "approvedBy": "5bb2575199d7179dfe85be02",
    "active": true,
    "activatedAt": "2020-10-22T14:12:32.316Z",
    "installed": true,
    "installedBy": true,
    "uninstalledAt": "2020-10-22T14:12:32.316Z",
    "uninstalledBy": "5bb2575199d7179dfe85be02",
    "uninstalledReason": "mudança de ERP",
    "pendingUpdate": true,
    "pendingUpdateSince": "2020-10-22T14:12:32.316Z",
    "requiresManualUpdate": true,
    "status": "pending_approval",
    "consentedFeatures": [
      {
        "id": "api:group:read",
        "consentedAt": "2020-10-22T14:12:32.316Z"
      }
    ],
    "contactInfo": {
      "name": "Responsável pelo app",
      "telephone": "(11)99999-9999",
      "message": "Caso tenha qualquer dúvida, entre em contato por telefone ou whatsapp!"
    }
  }
]
CopiarCopiado