Search docs/

Prover Documentos

{...}

O Hub de API's na 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 eventos por meio da action @layers:Documents: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:Documents:getRelated
CopiarCopiado

Requisição

Especificação

  • contextObjectobrigatório

  • secretStringobrigatório

    Chave secreta específica do app

  • dataObject

Exemplo

{
  "context": {
    "issuedAt": "2021-09-24T22:58:56.758Z",
    "action": "@layers:identificador_da_action",
    "community": "test"
  },
  "secret": "exemplo",
  "data": {
    "user": {
      "id": "exemplo",
      "name": "Carlos Pereira",
      "alias": "user2",
      "timezone": "America/Sao_Paulo",
      "language": "pt/BR",
      "accountId": "exemplo"
    }
  }
}
CopiarCopiado

Resposta

Especificação

  • resultObject[ ]obrigatório

Exemplo

{
  "result": [
    {
      "id": "0001",
      "title": "Nome do aluno",
      "attachments": [
        {
          "title": "CalculoDeNotas.pdf",
          "type": "file`",
          "url": "https://calculo.pdf"
        }
      ]
    }
  ]
}
CopiarCopiado