{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"425c4cdf-64b7-41e9-a6eb-114b73a6793e","name":"Matrícula","description":"# 📚 Matrícula API\n\nEsta coleção reúne os endpoints utilizados pelas Instituições de Ensino para integração com o sistema de matrículas da SPTrans. Ela cobre autenticação, gestão de cadastro da instituição, gestão de turmas e operações de matrícula de estudantes.\n\n## Visão geral\n\nA API permite que times de TI das instituições:\n\n- Autentiquem a integração da instituição com a SPTrans;\n    \n- Consultem e gerenciem cursos e turmas;\n    \n- Realizem matrícula individual ou em lote de estudantes;\n    \n- Consultem e cancelem matrículas existentes;\n    \n- Atualizem dados de acesso da instituição (email e senha).\n    \n\n## Fluxo recomendado de uso\n\n1. **Login**\n    \n    - Execute o endpoint **Login** para autenticar a instituição.\n        \n    - O login retorna um JWT e demais dados necessários, que são salvos nas variáveis de ambiente (como `jwt`, `xsession` e `token`).\n        \n    - Todos os demais endpoints dependem de uma autenticação válida.\n        \n2. **Gestão de Turmas e Cursos**\n    \n    - Utilize os endpoints de **Gestão de Turmas** para listar cursos, consultar, criar e editar turmas.\n        \n    - Esses recursos são pré-requisitos para vincular corretamente as matrículas aos cursos/turmas corretos.\n        \n3. **Gestão de Matrículas**\n    \n    - Use os endpoints da pasta **Gestão de Matrículas** para enviar, consultar e cancelar matrículas de estudantes, seja individualmente ou em lote.\n        \n4. **Gestão de Cadastro da Instituição**\n    \n    - Quando necessário, utilize os endpoints de **Gestão de Cadastro** para atualizar email de contato e senha de acesso da instituição.\n        \n\n## Pré-requisitos\n\n- **Ambiente ativo**: selecione o ambiente adequado (por exemplo, `Produção`).\n    \n- **Variáveis de ambiente**: garantir que `baseURL` esteja configurada e visível; demais credenciais devem ser mantidas como variáveis seguras.\n    \n- **Chaves de acesso**: quando requerido, informe `x-api-key` ou outros headers de autenticação/documentados nos próprios endpoints.\n    \n\n## Execução e testes\n\n- Utilize os **exemplos já salvos** em cada request para referência de respostas típicas (como 200, 401, 403).\n    \n- Os scripts de teste existentes propagam automaticamente `jwt`/`xsession` após um login bem-sucedido — não altere esses scripts ao consumir a coleção.\n    \n- Recomenda-se seguir a ordem lógica das pastas (Login → Gestão de Turmas → Gestão de Matrículas → Gestão de Cadastro) ao explorar e testar a API.  \n    \n\n---\n\n## **❗ Requisitos de acesso**\n\nPara utilizar as APIs, é necessário possuir:\n\n- **API Key do Documento do Estudante (DNE)**\n    \n    Solicite a sua através do e-mail: [<b>instituicao.sptrans@dne.com.br</b>](https://mailto:instituicao.sptrans@dne.com.br)\n    \n- **Usuário e senha da SPTrans**\n    \n    Os mesmos utilizados para acesso ao portal institucional da SPTrans.\n    \n\n---\n\n## **🛟 Ajuda e suporte**\n\nEm caso de dúvidas ou necessidade de suporte, nossa equipe está à disposição.\n\n- **Canal de atendimento:** [instituicao.sptrans@dne.com.br](https://malito:instituicao.sptrans@dne.com.br)\n    \n- Ou entre em contato com o gerente de integração responsável pela sua instituição.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"20905871","team":84110,"collectionId":"425c4cdf-64b7-41e9-a6eb-114b73a6793e","publishedId":"2sAY519Lj1","public":true,"publicUrl":"https://api-matricula.dne.com.br","privateUrl":"https://go.postman.co/documentation/20905871-425c4cdf-64b7-41e9-a6eb-114b73a6793e","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Plataforma de API's para integração de matrículas das instituições de ensino com a SPTrans."},{"name":"title","value":"Matricula"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.6","publishDate":"2024-11-11T13:50:31.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Matricula","description":"Plataforma de API's para integração de matrículas das instituições de ensino com a SPTrans."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/c1bc9a1fe3187760f9bf7628f78ea45f9ed8e1363d90c5948102192fc6f6d6ed","favicon":"https://res.cloudinary.com/postman/image/upload/v1560888093/team/niiyw8sgi6ig4qgj9us3.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-matricula.dne.com.br/view/metadata/2sAY519Lj1"}