Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Expandir
titleAutenticação

As APIs disponibilizadas funcionam com duas autenticações, Basic ou Token Bearer, nos dois casos é necessário um usuário e senha do RM previamente disponibilizado

Deck of Cards
idAutenticacaoAPI
Card
idBasic
labelBasic

Authorization - Basic Auth

Username <USUARIO RM>

Password <SENHA RM>


Card
idBearer
labelBearer

Abaixo estão as instruções de como buscar um bearer token, tanto com base em um certificado embutido automaticamente na aplicação quanto um inserido manualmente.

Exemplo de utilização - Sucesso:

  1. Realize uma requisição POST ao endpoint http(s)://{dominio}:{porta}/api/connect/token/ via Postman, SoapUi, ou outro programa que realize requisições HTTP REST.
  2. No corpo da requisição envie um JSON explicitando usuário e senha do RM para qual a autenticação está sendo direcionada:

 username
• password 

A requisição deve parecer com a abaixo


Bloco de código
languagejs
themeMidnighttext
titleJSON de requisição de token
{
 "username": "USUARIO RM",
 "password": "SENHA RM"
}


O token de segurança será gerado e já poderá ser utilizado no cabeçalho das requisições subsequentes às API's disponibilizadas pela TOTVS.

Exemplo de Token de Segurança gerado com sucesso e pronto para ser utilizado:


Bloco de código
languagejs
themeMidnighttext
titleJSON de Retorno de Token
{
    "access_token": "eyJhbGciOiJSUzI1NiIsDKXI9RYRNIpq4zd2ZFTuKRAvvTLvytOW_yvYxUn-k-XM4stBcnzuo8Eg00A8mDePRH-Kcjy6AWZjOPGYuaiKnDZ5hWfVCO-mefV44wU1vAYSb3jWQuS-4SPgrmHHy3XurY1clVpwrHuIENsZdFSZxy-g0I_8VwCFZHIPGh4-s_uejDPTmkscCWoejc42nyE8zn8gkG1YYWQRQ",
    "expires_in": 300,
    "refresh_token": "eyJUb2tlbktleSI6ImROcU5pam9BbnZhaG1WMEZST1o1NjFYQlVZekIzSXplYldNdDZkcUFyVE0iLCJjb25uZWN0aW9uSWQiOiJDb3Jwb3JlUk0ifQ==",
    "token_type": "Bearer"
}


Utilize o token gerado incluindo-o no cabeçalho da requisição através da diretiva:

• Authorization: Bearer {token}

Inclusão do token no cabeçalho da requisição:


Após a inclusão do cabeçalho de autorização, realize uma requisição HTTP em uma das API's disponibilizadas pela TOTVS e verifique o resultado.


Expandir
titleBuscar Etapas
HTML
<div class="post">GET</div>
<div class="endereco">/api/integracoes/v2/sesc/educacional/etapa</div>


Para buscar varias etapas no SGE, o filtro da busca deve ser passado via QueryString.

codColigada: Coligada da Turma/Disciplina no RM

idTurmaDisc: Id da Turma/Disicplina no RM

tipoEtapa: N para nota ou F para falta



Bloco de código
languagejs
themetextMidnight
titleExemplo
/api/integracoes/v2/sesc/educacional/etapa?codColigada=2&idTurmaDisc=4151&tipoEtapa=N
Bloco de código
languagejs
themeMidnight
titleExemplo de Resposta
collapsetrue
{
    "hasNext": false,
    "items": [
        {
            "codColigada": 2,
            "idTurmaDisc": 572,
            "codEtapa": 1,
            "dataInicio": "2024-01-01T00:00:00-03:00",
            "dataFim": "2024-01-31T00:00:00-03:00",
            "tipoEtapa": "N",
            "pontosDistribuidos": 100.0000,
            "media": 60.0000,
            "permiteDigitacaoNaEtapa": false,
            "etapaFinal": false,
            "etapaEncerrada": false
        },
        {
            "codColigada": 2,
            "idTurmaDisc": 572,
            "codEtapa": 2,
            "dataInicio": "2024-01-01T00:00:00-03:00",
            "dataFim": "2024-12-31T00:00:00-03:00",
            "tipoEtapa": "N",
            "pontosDistribuidos": 100.0000,
            "media": 60.0000,
            "permiteDigitacaoNaEtapa": false,
            "etapaFinal": false,
            "etapaEncerrada": false
        }
    ]
}


Também é possível buscar uma etapa especifica, para isso os dados da chave devem ser passados na URL separados por pipeline "|", devem ser passados o codColigada, idTurmaDisc, codEtapa e tipoEtapa.

Bloco de código
languagejs
themeMidnight
titleExemplo
collapsetrue
/api/integracoes/v2/sesc/educacional/etapa/2|572|1|N
Bloco de código
languagejs
themeMidnight
titleRetorno
collapsetrue
{
    "codColigada": 2,
    "idTurmaDisc": 572,
    "codEtapa": 1,
    "dataInicio": "2024-01-01T00:00:00-03:00",
    "dataFim": "2024-01-31T00:00:00-03:00",
    "tipoEtapa": "N",
    "pontosDistribuidos": 100.0000,
    "media": 60.0000,
    "permiteDigitacaoNaEtapa": false,
    "etapaFinal": false,
    "etapaEncerrada": false
}

...