Guia de Migração para a Nova API

Este guia tem como objetivo auxiliar os usuários na adaptação de seus sistemas para a nova API. Serão detalhadas as principais mudanças em autenticação, endpoints, parâmetros de requisição e formatos de resposta.

1. Introdução

A nova API foi desenvolvida para oferecer melhorias em segurança, desempenho e flexibilidade. Com a migração, é fundamental que os usuários compreendam as alterações necessárias para garantir a continuidade dos serviços.

2. Mudanças na Autenticação

API Antiga

• Método: Autenticação realizada via usuário, senha e chave fornecidos diretamente.
• Formato: A chave era passada como parte da URL.

Nova API

• Método: Autenticação baseada em OAuth 2.0 utilizando Laravel Passport.
• Formato: Os usuários recebem um client_id e um client_secret.
• Antes de acessar os endpoints, é necessário obter um Access Token usando o client_id e client_secret.
  • SOLICITE O TOKEN através de https://suporte.ifrs.edu.br , selecionado a Categoria Reitoria -> Sistemas -> API
    • Para ambiente de Teste e após validação, Produção.

Passo a Passo para Autenticação

Passo 1: Solicitar Access Token

• Método: POST
• URL de Desenvolvimento: https://dev8e.ifrs.edu.br/oauth/token
• URL de Produção: https://app.ifrs.edu.br/oauth/token

Requisição cURL

curl -X POST https://app.ifrs.edu.br/oauth/token \
     -H "Content-Type: application/json" \
     -d '{"grant_type": "client_credentials", "client_id": "SEU_CLIENT_ID", "client_secret": "SEU_CLIENT_SECRET"}'

Passo 2: Usar o Access Token

• Após obter o token, inclua-o no header de autorização para todas as requisições.
• Formato do Header:

Authorization: Bearer SEU_ACCESS_TOKEN

Exemplo de Uso do Token

Requisição cURL

curl -X GET "https://app.ifrs.edu.br//api/v1/sig/sigaa/alunos?login={login}" \
     -H "Authorization: Bearer SEU_ACCESS_TOKEN"

3. Mudanças nos Endpoints

Principais Alterações

• Prefixo: Todos os endpoints agora têm o prefixo /api/v1/sig/.
• Filtros: Parâmetros de filtro não são mais passados na URL, mas como parâmetros de consulta.
• Endpoint Modificado: O endpoint /matriculados sofreu alterações nos parâmetros e no formato de retorno.

4. Exemplos de Requisição

Buscar Aluno por Login

API Antiga:
GET /sig/service/alunos/login/12345678900/chave/VALOR

Nova API:
GET /api/v1/sig/sigaa/alunos?login=12345678900

Listar Todos os Servidores Ativos

API Antiga:
GET /sig/service/servidores/status/ativo/chave/VALOR

Nova API:
GET /api/v1/sig/servidores?status=ativo

Buscar Matriculados em um Período

API Antiga:
GET /sig/service/matriculados/ano/2024/periodo/2/chave/VALOR

Nova API:
GET /api/v1/sig/sigaa/matriculados?periodo_letivo=2024/2

5. Considerações Adicionais

Paginação

• O endpoint /matriculados suporta paginação através do parâmetro per_page.
• Exemplo:

GET /api/v1/sig/sigaa/matriculados?per_page=50

Tipos Especiais de Requisição

• Parâmetro tipo=extracao: Para extração personalizada de campos.
• Exemplo:

GET /api/v1/sig/sigaa/matriculados?tipo=extracao&extracao_campos=Nome,Matricula,Email,Curso

• Para busca de não matriculados:

GET /api/v1/sig/sigaa/matriculados?matriculado=nao

Substituição de Parâmetros

• Os parâmetros ano e periodo foram substituídos por periodo_letivo ou ano_ingresso.

6. Dicas e Suporte

• Teste a integração em ambiente de homologação antes de migrar.
• Documentação completa disponível no Swagger.
• Para dúvidas ou problemas, entre em contato com o suporte via GLPI.