Para desenvolvedores
Uma API de integração. Todos os clientes usam os mesmos endpoints, e o que existe e o que é planejado aparecem separados.
Formato da API
- Caminho base
/v1, JSON, UTF-8. Authorization: Bearer <credential>. A credencial de integração é uma chave de API da instituição, guardada em um servidor. O token de sessão do aluno é de curta duração e é emitido por uma integração.- A instituição vem somente da credencial. Nenhum campo da requisição pode selecionar outra instituição.
- As escritas levam identificadores estáveis e são idempotentes. Repetir com o mesmo identificador retorna
duplicate. acceptedsignifica apenas armazenado. Nunca significa avaliado, dominado ou aprovado.- Os clientes não podem declarar acertos, notas nem autoridade.
O que existe e o que é planejado
| Recurso | Situação | Observações |
|---|---|---|
Identidade e descoberta: GET /v1/whoami e GET /v1/capabilities |
Construído no código, fora de operação | Autenticação por chave de API revisada. Fora de operação. |
| Operações da API de integração v1: vínculos de pessoas, sessões de aluno, leitura de catálogo, entregas, envios de arquivos, lotes de evidências, presença, conclusões de aula, autorrelato e política | Construído no código, fora de operação | A leitura de capacidades informa que estão implementadas no código. Fora de operação e sem disponibilidade pública. |
| Lançamento de ferramenta LTI 1.3 | Construído no código, fora de operação | O Moodle é a plataforma de referência planejada. Nenhum LMS foi conectado. |
| Lançamento cmi5 e lançamento SCORM 1.2 | Construído no código, fora de operação | Sem funcionamento público. |
| Declarações xAPI emitidas para o repositório privado de registros da própria plataforma | Construído no código, fora de operação | O serviço do repositório ainda não foi qualificado nem ativado. É um motor interno e não expõe nenhum endpoint aos clientes. |
| SDK JavaScript com suporte offline e executor de referência | Construído no código, fora de operação | Não publicado como pacote. Não verificado em navegadores reais. |
| Endpoint xAPI padrão para produtores externos (xAPI 2.0 e 1.0.3) | Planejado, não construído | Nenhuma conformidade é afirmada. |
| Credenciais Open Badges 3.0 e Comprehensive Learner Record | Planejado, não construído | A emissão de credenciais verificadas também é um serviço opcional planejado. |
| Publicação de notas de volta nas instituições | Planejado, não construído | Informado como não implementado pela leitura de capacidades. |
| Gamificação: extrato, prêmios, salões da fama e campeonatos | Planejado, não construído | Existem requisitos. Nada foi construído. |
Clientes
O iMagine Playground e o executor de referência incluído são clientes comuns. Eles usam os mesmos endpoints de qualquer cliente de terceiros, sem caminho privilegiado. Os aplicativos de aluno nunca recebem a chave da instituição, apenas um token de sessão de curta duração emitido pelo servidor da própria integração.
Nenhuma afirmação de certificação ou conformidade
A GAMERIZE não afirma certificação nem conformidade com nenhum padrão. Frases como "em conformidade com … testado com …" só serão publicadas junto com as evidências executadas que as sustentam. Ainda não existe nenhuma.
Documentação
O contrato de integração acordado (versão 1, revisão 0.3) está no repositório do projeto. Ainda não existe documentação hospedada, por isso esta página não aponta para nenhuma.