Motimate: Como usar a API pública para provisionar e gerenciar usuários e grupos?

Você pode provisionar e gerenciar usuários no Motimate conectando seu sistema de origem à nossa API REST. Isso permite que você lide com vários trabalhos essenciais no Motimate, como criar usuários, atualizar usuários, excluir usuários, criar grupos e provisionar usuários para os grupos corretos. 

Informações básicas: 

• Todos os usuários e grupos têm seus IDs Motimate exclusivos que podem ser usados com a API, mas você também pode definir um "ID externo" que pode ser usado com a API. Essa "ID externa" normalmente é definida para corresponder à ID que você tem para esse usuário ou grupo em sua própria fonte de dados. 
   
• Os grupos são usados para criar uma hierarquia ou árvore de grupos. Em geral, ele espelha a estrutura da sua organização e é usado para delegar treinamento e obter relatórios. Isso geralmente se baseia em departamentos e equipes ou em regiões. Recomendamos criar grupos antes de criar usuários para que você possa atribuir usuários diretamente a grupos após a criação. Consulte aqui para obter mais informações sobre a estrutura do grupo.
   
• A posição de um usuário permite que você delegue treinamento com base na função dele na organização. Consulte aqui para obter mais informações sobre as posições de usuário.
   
• Recomendamos que você configure um ambiente de teste para testar suas chamadas e a integração como um todo, antes de transferi-las para o ambiente de produção. Entre em contato com o Customer Success Manager ou com o site support@motimateapp.com para obter assistência. 
   
• A API do Motimate está no formato JSON. 

Criação de grupos

Para criar grupos, use a seguinte chamada:
POST https://motimateapp.com/public_api/groups

Adicione o payload ao corpo com as informações necessárias com o grupo. O campo "parent_id" é usado para criar uma estrutura de grupo. Ao inserir o ID de um grupo diferente nesse campo, você definirá esse grupo como o pai.

Observação: o nível do grupo deve estar em uma hierarquia inferior à do grupo pai, sendo que o "Nível 1" é o nível mais alto. Isso permite que você importe estruturas de grupo para sua conta do Motimate. 

Atualização de grupos 

Para atualizar um grupo no Motimate, você precisará da seguinte chamada. O ID usado neste exemplo é o ID do grupo Motimate. 

PATCH https://motimateapp.com/public_api/groups/{group_id}

Adicione o payload ao corpo com os dados necessários que você deseja atualizar nos Grupos. Isso pode ser usado quando um grupo precisa ser movido para um nível diferente ou se a estrutura precisa ser ajustada. 

 

Exclusão de grupos

Para excluir um grupo no Motimate, você precisará da seguinte chamada. O ID usado neste exemplo é o ID do grupo Motimate. Se você definir force como "1", o registro será destruído, e não há como recuperar o grupo nesse cenário.

APAGAR https://motimateapp.com/public_api/groups/{group_id}

A execução dessa chamada excluirá o grupo selecionado, embora uma resposta não seja retornada:

 

Criação de usuários

Para criar usuários, use a chamada a seguir: 

POST https://motimateapp.com/public_api/users

Adicione o payload ao corpo com as informações necessárias do usuário. O endereço de e-mail ou o número de telefone será um campo obrigatório, dependendo das configurações da sua conta Motimate. Você pode selecionar os grupos do usuário usando o campo de atribuições de grupo. Digite o ID do grupo do qual você deseja que o usuário faça parte e a função dele no grupo (membro, administrador ou observador). Recomendamos que você defina assing_ancestors como "true" na grande maioria dos cenários. Isso garante que os usuários sejam membros dos grupos principais de seus grupos atribuídos. 

 

Atualização de usuários

Para atualizar as informações de um usuário no Motimate, você precisará da seguinte chamada. O ID usado neste exemplo é o ID de usuário do Motimate. 

PATCH https://motimateapp.com/public_api/users/{user_id}?identifier_type=id

Adicione o payload ao corpo com os únicos dados necessários que você deseja atualizar para o usuário.

 

Exclusão de usuários

Para excluir um usuário no Motimate, você precisará da seguinte chamada. O ID usado neste exemplo é o ID de usuário do Motimate. Se você definir force como "1", o registro será destruído, e não há como recuperar o grupo nesse cenário. Se você definir esse valor como "0", o registro será excluído suavemente, permitindo que seja recuperado, se necessário. 

DELETE https://motimateapp.com/public_api/users/{user_id}?force=1&identifier_type=id

A execução dessa chamada excluirá o usuário selecionado, embora uma resposta não seja retornada: 

Como restaurar usuários

Às vezes, um usuário é excluído por engano e precisa ser restaurado. Se eles tiverem sido excluídos suavemente, e não destruídos de forma definitiva, isso poderá ser feito com a seguinte chamada. O ID usado neste exemplo é o ID de usuário do Motimate. 

PATCH https://motimateapp.com/public_api/users/{user_id}/restore?identifier_type=id