É necessário o plugin LOGIN SSO ativado para este recurso.

Para fazer o login automático de um aluno e criar uma conta instantaneamente (se ele ainda não tiver), utilize:

POST /api/v1/sso

Enviando os seguintes dados:

Campo

Tipo

Obrigatório

name

string

sim

email

string

sim

Ao enviar uma solicitação, você receberá uma url única que fará o login automático para o aluno informado. Você deve redirecionar o aluno para essa url e nós cuidaremos do resto. Essa url só funciona uma única vez e cada novo SSO deve ser gerada.

Por exemplo:

$client = new Guzzle\Client;

$response = $client->request('POST', 'https://app.alpaclass.com/api/v1/sso', [
  'headers' => [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
    'Authorization' => 'Bearer seu_token_de_api'
  ],
  'body' => [
    'name' => 'Diego Alves Souza',
    'email' => '[email protected]',
  ]
])->getBody()->getContents();

Exemplo de resposta recebida com a url que você deve redirecionar o aluno. Enviamos também o ID do aluno caso precise fazer coisas, como matricular em cursos, antes de redirecionar para sua escola na Alpaclass.

{
    "url": "https://minhaescola.alpaclass.com/sso/FIeciqTSaG52pAAHEyzwH",
    "student": {
        "id": 43,
        "name": "Mr. Gato",
        "email": "[email protected]",
        "created_at": "2022-06-29 07:44:16"
    }
}

Caso o aluno não exista na sua escola, a conta será criada com os dados informados e uma senha aleatória.
Por utilizar o SSO, provavelmente seu aluno nunca precise dessa senha. Por isso, nenhuma notificação será enviada para o aluno sobre a criação de conta neste caso. Caso ele precise da senha, pode seguir o fluxo de recuperação de senha para fazer o login normalmente via site (sem o SSO).