Search docs/

Sincronizar Dados

{...}

A sincronização de dados permite que sejam criados usuários, membros, grupos e seus vínculos por meio de uma única requisição. Esse processo pode ser feito substituindo as informações já cadastradas pelas informações na payload ou apenas adicionando as novas iformações sem remover as que não estão na payload.

POST https://api.layers.digital/v1/sync
CopiarCopiado

Autenticação

Autenticação do tipo Token Bearer é necessária para acessar essa rota. O app deve estar cadastrado para usar a API com a permissão sync:manage

Parâmetros

  • community-id
    (header)
    obrigatório
    Identificador da comunidade

Requisição

Especificação

Exemplo

{
  "users": {
    "data": [
      {
        "active": true,
        "invite": true,
        "rolesSet": {
          "role": true
        },
        "alias": "123abc",
        "email": "gabriel.raniere@layers.education",
        "name": "Gabriel Raniere",
        "birth": "05/12/2000"
      }
    ],
    "cleanSync": true
  },
  "members": {
    "data": [
      {
        "active": true,
        "users": [
          "gabriel.raniere@layers.education"
        ],
        "alias": "456def",
        "birth": "22/08/2004",
        "name": "Rafael Teles"
      }
    ],
    "cleanSync": true
  },
  "classrooms": {
    "data": [
      {
        "active": true,
        "alias": "2ANOEM",
        "name": "2˚ Ano do Ensino Médio",
        "members": [
          "123abc"
        ],
        "admins": [
          "gabriel.raniere@layers.education"
        ],
        "tags": [
          "Ensino Medio"
        ]
      }
    ]
  }
}
CopiarCopiado

Resposta

Especificação

  • usersString[ ]

    Array contendo os identificadores dos documentos de usuários criados

  • membersString[ ]

    Array contendo os identificadores dos documentos de membros criados

  • groupsString[ ]

    Array contendo os identificadores dos documentos de grupos criados

Exemplo

{
  "users": [
    "exemplo"
  ],
  "members": [
    "exemplo"
  ],
  "groups": [
    "exemplo"
  ]
}
CopiarCopiado