Vamos entender como funcionar a autorização utilizando o token de api da AlpaClass.

URL da API

A API da AlpaClass está localizada na seguinte URL base:

https://alpaclass.com/api/v1

Utilizando o Token

Para autenticar sua requisição na API da AlpaClass, é necessário enviar o token em todas as requisições através do Bearer Token.

Envie também os headers:

  • Accept: application/json
  • Content-Type: application/json

Por exemplo, para receber a lista de todos os conteúdos cadastrados na sua escola:

$client = new Guzzle\Client;

$response = $client->request('GET', 'https://alpaclass.com/api/v1/contents', [
  'headers' => [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
    'Authorization' => 'Bearer seu_token_de_api'
  ]
])->getBody()->getContents();

Respostas e Erros

A AlpaClass usa respostas com códigos HTTP convencionais para indicar o sucesso ou falha de uma solicitação de API. A tabela abaixo contém um resumo dos códigos de resposta típicos:

Código

Descrição

200

Tudo certo.

400

Dados válidos foram fornecidos, mas a solicitação falhou.

401

Nenhum token de API válido foi fornecido.

402

A requisição não foi autorizada.

404

O recurso solicitado não foi encontrado.

422

A requisição não possui parâmetros obrigatórios ou foram fornecidos dados inválidos.

429

Muitas tentativas em pouco tempo.

500

A solicitação falhou devido a um erro interno na AlpaClass.

503

A AlpaClass está offline para manutenção.