• Português
      • Aviso de tradução por IA

      Esta documentação foi traduzida automaticamente por IA.

      Sincronizando Dados de Usuário via API HTTP

      Obtendo uma Chave de API

      Consulte Chaves de API. Certifique-se de que a função associada à chave de API tenha as permissões necessárias para sincronizar dados de usuário.

      Visão Geral da API

      Exemplo

      curl 'https://localhost:13000/api/userData:push' \
  -H 'Authorization: Bearer <token>' \
  --data-raw '{"dataType":"user","records":[]}' # Veja os detalhes do corpo da requisição abaixo

      Endpoint

      POST /api/userData:push

      Formato dos Dados de Usuário

      UserData

      ParâmetroTipoDescrição
      dataType'user' | 'department'Obrigatório. Tipo de dado sendo enviado. Use user para enviar dados de usuário.
      matchKey'username' | 'email' | 'phone'Opcional. Usado para encontrar usuários existentes no sistema com base no campo especificado.
      recordsUserRecord[]Obrigatório. Array de registros de dados de usuário.

      UserRecord

      ParâmetroTipoDescrição
      uidstringObrigatório. Identificador único para os dados do usuário de origem, usado para associar os dados de origem ao usuário do sistema. Imutável para um usuário.
      nicknamestringOpcional. Apelido do usuário.
      usernamestringOpcional. Nome de usuário.
      emailstringOpcional. Endereço de e-mail do usuário.
      phonestringOpcional. Número de telefone do usuário.
      departmentsstring[]Opcional. Array de UIDs dos departamentos aos quais o usuário pertence.
      isDeletedbooleanOpcional. Indica se o registro foi excluído.
      <field>anyOpcional. Campos personalizados na tabela de usuário.

      Formato dos Dados de Departamento

      Info

      Para enviar dados de departamento, o plugin Departamentos precisa estar instalado e ativado.

      DepartmentData

      ParâmetroTipoDescrição
      dataType'user' | 'department'Obrigatório. Tipo de dado sendo enviado. Use department para dados de departamento.
      recordsDepartmentRecord[]Obrigatório. Array de registros de dados de departamento.

      DepartmentRecord

      ParâmetroTipoDescrição
      uidstringObrigatório. Identificador único para os dados do departamento de origem, usado para associar os dados de origem ao departamento do sistema. Imutável.
      titlestringObrigatório. Título do departamento.
      parentUidstringOpcional. UID do departamento pai.
      isDeletedbooleanOpcional. Indica se o registro foi excluído.
      <field>anyOpcional. Campos personalizados na tabela de departamento.
      Info
      1. O envio de dados é uma operação idempotente.
      2. Se um departamento pai não existir ao enviar dados de departamento, a associação não poderá ser feita. Você pode enviar os dados novamente após a criação do departamento pai.
      3. Se o departamento de um usuário não existir ao enviar dados de usuário, o usuário não poderá ser associado a esse departamento. Você pode enviar os dados do usuário novamente após o envio dos dados do departamento.