Search docs/

Prover Calendário

{...}

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 calendário por meio da action @layers:Calendar: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:Calendar:getRelated
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": "Carlos Pereira",
      "alias": "user2",
      "timezone": "America/Sao_Paulo",
      "language": "pt/BR",
      "accountId": "5bb2575199d7179dfe85be02"
    }
  }
}
CopiarCopiado

Resposta

Especificação

  • resultObject[ ]obrigatório

Exemplo

{
  "result": [
    {
      "id": "0001",
      "summary": "Calendário acadêmico",
      "description": "Calendário acadêmico geral",
      "timezone": "America/Sao_Paulo",
      "events": [
        {
          "id": "0001",
          "summary": "Natal",
          "start": "2020-09-15T14:14:14.277Z",
          "end": "2020-09-15T14:14:14.277Z",
          "category": "Eventos",
          "color": "orange",
          "createdAt": "2020-09-15T14:14:14.277Z"
        }
      ],
      "categories": [
        {
          "name": "Eventos",
          "color": "aqua"
        }
      ]
    }
  ]
}
CopiarCopiado