Search docs/

Prover informações da home

{...}

O Hub de API's no Layers permite que apps troquem informações por meio de actions: protocolos especificando o formato de requisição e resposta aceitos para uma determinada informação. Apps que provém informações de grade horária por meio da action @layers:education:Timetables:getRelated receberão a requisição no formato abaixo e devem respondê-la com todos os campos obrigatórios.

POST https://api.provedor-registrado.com/v1/layers:getHomeInfo
CopiarCopiado

Requisição

Especificação

  • contextObjectobrigatório

  • secretStringobrigatório

    Chave secreta específica do app

  • dataObject

Exemplo

{
  "context": {
    "issuedAt": "2020-09-15T14:14:14.277Z",
    "action": "@layers:identificador_da_action",
    "community": "test"
  },
  "secret": "exemplo",
  "data": {
    "user": {
      "id": "5bb2575199d7179dfe85be02",
      "name": "João Pedro",
      "alias": "0001",
      "timezone": "America/Sao_Paulo",
      "language": "pt/BR",
      "accountId": "5bb2575199d7179dfe85be02"
    }
  }
}
CopiarCopiado

Resposta

Especificação

  • badgeNumber

    O badge indica a se há notificações do seu app a serem vistas. Se for um booleano mostrará o badge quando for `true` e não quando for `false` e se for um número mostrará o badge com a contagem quando o valor for maior que 1

  • featuredObject

    Informações de destaque

Exemplo

{
  "badge": 1,
  "featured": {
    "title": "1 novo item na agenda",
    "cards": [
      {
        "label": "Evento",
        "title": "Festa Junina",
        "description": "A festa junina será realizada no dia 12/06/2020. Todos estão convidados!",
        "mood": "neutral",
        "image": "https://imagem.com",
        "location": "/portal/portalAlias/path/a/b/c"
      }
    ]
  }
}
CopiarCopiado