Motimate: Como você pode usar a API pública do Motimate?
Use a API pública para automatizar a integração e a sincronização do usuário com a sua fonte de dados e conecte o Motimate a outros serviços interessantes 🔀
A API pública v2 já está disponível para todos os clientes!
- Documentação do PAPI v1 (Somente legado - todos os novos clientes receberão a v2)
- Documentação para PAPI v2
A API pública é um conjunto de serviços que podem ser usados para atualizar e gerenciar dados no Motimate. Ela é documentada de forma padrão, chamada OpenAPI, e fornece aos desenvolvedores acesso programático ao nosso software como um serviço. Essa API tem suporte mais amplo do que o que você pode fazer com SCIM e CSV, mas você precisa de um serviço de integração ou robô de software para usá-la.
O lançamento do PAPI v2 torna mais fácil do que nunca exportar dados do seu MotiSpace, com pontos de extremidade como:
Observe:
- Você precisa solicitar suas credenciais de API ao Suporte para começar a usar esse serviço.
- O banco de dados da API é atualizado em intervalos regulares , algumas vezes a cada hora.
Modelos de dados
A API pública fornece modelos para automatizar o provisionamento de usuários e as postagens do Pulse. Ele tem esses modelos de dados:
-
Modelo de usuário: Você pode usar isso para ler, gravar e atualizar informações sobre contas de usuário. Isso pode incluir informações de contato, funções de acesso e atribuições de grupos para o gerenciamento do movimento. Se um usuário tiver uma ou várias posições, isso também poderá ser definido nesse ponto de extremidade.
-
Modelo de grupos: Permite que você leia, grave e atribua grupos de usuários. Esses grupos também podem ser estruturados em uma estrutura de árvore para se adequar à sua organização e simplificar as tarefas de aprendizagem.
Importante: no momento, o nível do grupo é definido usando o atributo kind. O valor do tipo pode variar de uma organização para outra. Ele também pode ser alterado facilmente pelo administrador da organização. Ao configurar a integração da API, é recomendável que você defina uma lista permanente de nomes de tipo para os níveis de grupo para evitar possíveis erros na integração da API caso os nomes de tipo sejam alterados.
-
Modelo de posições: Esse modelo permite que você leia e grave posições às quais as contas de usuário podem ser atribuídas.
-
Postagens: Você pode usar essa opção para criar posts e publicá-los no Pulse. Isso pode ser feito em combinação com os serviços de arquivos para carregar imagens.
-
Arquivos: Esse serviço é usado para carregar imagens para os posts do Pulse. O limite de tamanho para imagens é de 40 MB, para vídeos é de 100 MB e para documentos é de 100 MB.
- Insights: Esse serviço é usado para gerar e obter um link para um relatório personalizado. O modelo de relatório deve ser criado previamente na plataforma Motimate usando o recurso "Gerar relatórios" em "Insights".
Autenticação
O ponto de extremidade do token OAuth é usado para criar o token de acesso. Obtenha seu client_id e client_secret entrando em contato com support@motimateapp.com.
Depois que você receber esses detalhes, os tokens poderão ser gerados de forma programática ou por meio de plataformas como o Postman. Tudo o que você precisa fazer é enviar uma chamada de API para o endpoint POST /oauth/tokenscom o client_id e as credenciais client_secret que você recebeu do Motimate Support como um corpo JSON.
A API responderá com um token exclusivo, que será válido por 24 horas. Você pode gerar quantos tokens precisar. O token deve ser passado para o cabeçalho Authorization como um token Bearer em suas solicitações para todos os outros pontos de extremidade ("Bearer "+[your_token]).
Exemplo:"Portador eyJhbkyFjHk0oIY6ghkkgRI1NiJ9.eyJ0b23Lo7G5jk7mJkYzdiZD"
Você pode usar o ponto de extremidade Ponto de extremidade GET /me é usado para verificar o token de acesso. Isso é útil se você tiver um repositório de chaves para manter seu token de acesso e quiser verificar se ele está funcionando sem invocar nenhuma chamada transacional.
Como você pode testar a API:
Para testar a API, recomendamos que você use uma plataforma de API, como a Postman. Você pode encontrar um guia sobre como importar a documentação completa da API do Motimate para o Postman e o Insomnia Collections aqui.
Você deve criar seu token de acesso à API conforme descrito acima e, em seguida, inserir esse token como um token Bearer na guia Authorization (Autorização) do Postman. Você pode então testar a API e analisar as respostas.
0 comentário
Por favor, entre para comentar.