API: Como criar e convidar novos usuários

Atualizado 6 months ago por Gabriella Khoury

O que é: API Skore

A sigla API deriva da expressão inglesa Application Programming Interface que, traduzida para o português, pode ser compreendida como uma interface de programação de aplicação. Ou seja, API é um conjunto de normas que possibilita a comunicação entre plataformas através de uma série de padrões e protocolos.

O Skore disponibiliza a sua API para que a sua empresa possa desenvolver uma estratégia de criação ou convite de novos usuários de uma forma mais automatizada e customizada. Por exemplo:

Conheça outras possibilidades de criação de usuários automaticamente no login: Página de Login.
Você pode conferir a documentação da nossa API clicando aqui.

Como criar novos usuários via API

Primeiramente, para manipular a API do Skore, você precisará de um token de autorização. Para conseguir um, basta enviar uma mensagem para o nosso Suporte 🦄.

De posse do token, você poderá usar a API para criar novos usuários no Skore diretamente. Para isto, você vai precisar:

  • Usar a nossa API /users POST;
  • É necessário enviar na chamada o name (nome do usuário), email (e-mail do usuário), password (senha do usuário), role (permissão do usuário: admin, expert ou student). O username  é opcional.

Quando você cria um usuário através dessa ação, ele não recebe nenhum tipo de comunicação proativa do Skore, sendo papel do administrador da plataforma comunicar ao usuário como ele deve se logar no ambiente, informando o e-mail (ou username) e senha cadastrados para ele.

Como convidar novos usuários via API

Primeiramente, para manipular a API do Skore, você precisará de um token de autorização. Para conseguir um, basta enviar uma mensagem para o nosso Suporte 🦄.

De posso do token você poderá usar a API para convidar novos usuários a acessar o Skore diretamente. Para isto, você vai precisar:

  • Usar a nossa API de /invites POST;
  • Enviar convites para os usuários, usando o e-mail deles.

Lembre-se de que usuários convidados receberão um e-mail de convite e deverão configurar a sua senha ao aceitá-lo, de modo a realizar o primeiro login.


O que você achou desse artigo? Gostou?


Powered by HelpDocs (opens in a new tab)