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

Image Added


Bloco de código
languagejs
themeMidnight
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:

Image Added


Bloco de código
languagejs
themeMidnight
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:

Image Added


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
titleEtapas
HTML
<div class="get">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/Disciplina no RM

tipoEtapa: N para nota ou F para falta


Image Added


Bloco de código
languagejs
themeMidnight
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": [
        {
HTML
<table class="jh-type-object jh-root"> <tbody class=""> <tr> <th class="jh-key jh-object-key">openapi</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">3.0.1</span> </td> </tr> <tr> <th class="jh-key jh-object-key">servers</th> <td class="jh-value jh-object-value"> <table class="jh-type-array"> <tbody class=""> <tr> <th class="jh-key jh-array-key">0</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">API para os parâmetros de sistemas do produtos TOTVS</span> </td> </tr> <tr> <th class="jh-key jh-object-key">url</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">{{host}}/api/framework/v1</span> </td> </tr> <tr> <th class="jh-key jh-object-key">variables</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">serverUrl</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">default</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">localhost</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">serverHttpPort</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">default</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">8051</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">info</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">API para os parâmetros de sistemas do produtos TOTVS</span> </td> </tr> <tr> <th class="jh-key jh-object-key">version</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">1.000</span> </td> </tr> <tr> <th class="jh-key jh-object-key">title</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Parametros de Sistema</span> </td> </tr> <tr> <th class="jh-key jh-object-key">contact</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">name</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">T-Talk</span> </td> </tr> <tr> <th class="jh-key jh-object-key">url</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">API.Totvs.com.br</span> </td> </tr> <tr> <th class="jh-key jh-object-key">email</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">[email protected]</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">x-totvs</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">messageDocumentation</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">name</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">systemParameters</span> </td> </tr> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Parâmetros de Sistema</span> </td> </tr> <tr> <th class="jh-key jh-object-key">segment</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Foundation</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">productInformation</th> <td class="jh-value jh-object-value"> <table class="jh-type-array"> <tbody class=""> <tr> <th class="jh-key jh-array-key">0</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">product</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Protheus</span> </td> </tr> <tr> <th class="jh-key jh-object-key">contact</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">[email protected]</span> </td> </tr> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Cadastro de parâmetros</span> </td> </tr> <tr> <th class="jh-key jh-object-key">adapter</th> <td class="jh-value jh-object-value"> <span class="jh-type-string jh-empty">(Empty Text)</span> </td> </tr> <tr> <th class="jh-key jh-object-key">helpUrl</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">link aqui</span> </td> </tr> <tr> <th class="jh-key jh-object-key">note</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Essa API exige que seja configurada a segurança no servidor (SECURITY=1).</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">paths</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">/systemParameters</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">get</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">tags</th> <td class="jh-value jh-object-value"> <table class="jh-type-array"> <tbody class=""> <tr> <th class="jh-key jh-array-key">0</th> <td class="jh-value jh-array-value"> <span class="jh-type-string">System Parameters</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">summary</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Retorna todos os parâmetros do sistema</span> </td> </tr> <tr> <th class="jh-key jh-object-key">x-totvs</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">productInformation</th> <td class="jh-value jh-object-value"> <table class="jh-type-array"> <tbody class=""> <tr> <th class="jh-key jh-array-key">0</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">product</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Protheus</span> </td> </tr> <tr> <th class="jh-key jh-object-key">available</th> <td class="jh-value jh-object-value"> <div> <span class="jh-type-bool-true">true</span> </div> </td> </tr> <tr> <th class="jh-key jh-object-key">note</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Este verbo esta disponivel com todos os parametros</span> </td> </tr> <tr> <th class="jh-key jh-object-key">minimalVersion</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">12.1.23</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Retorna todos os parâmetros do sistema</span> </td> </tr> <tr> <th class="jh-key jh-object-key">operationId</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">getSystemParameters</span> </td> </tr> <tr> <th class="jh-key jh-object-key">parameters</th> <td class="jh-value jh-object-value"> <table class="jh-type-array"> <tbody class=""> <tr> <th class="jh-key jh-array-key">0</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-array-key">1</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Order</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-array-key">2</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Page</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-array-key">3</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/PageSize</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-array-key">4</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-array-key">5</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">#/components/parameters/Codes</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-array-key">6</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/AcceptLanguage</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-array-key">7</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">#/components/parameters/Description</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">responses</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">200</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Operação realizada com sucesso</span> </td> </tr> <tr> <th class="jh-key jh-object-key">content</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">application/json</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">schema</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/SystemParameter_1_000.json#/definitions/PagedParameters</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">post</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">tags</th> <td class="jh-value jh-object-value"> <table class="jh-type-array"> <tbody class=""> <tr> <th class="jh-key jh-array-key">0</th> <td class="jh-value jh-array-value"> <span class="jh-type-string">System Parameters</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">summary</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Inclui o parâmetro passado na requisição</span> </td> </tr> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Inclui o parâmetro passado na requisição</span> </td> </tr> <tr> <th class="jh-key jh-object-key">operationId</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">postParameter</span> </td> </tr> <tr> <th class="jh-key jh-object-key">x-totvs</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">productInformation</th> <td class="jh-value jh-object-value"> <table class="jh-type-array"> <tbody class=""> <tr> <th class="jh-key jh-array-key">0</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">product</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Protheus</span> </td> </tr> <tr> <th class="jh-key jh-object-key">available</th> <td class="jh-value jh-object-value"> <div> <span class="jh-type-bool-true">true</span> </div> </td> </tr> <tr> <th class="jh-key jh-object-key">note</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Este verbo esta disponivel com todos os parametros</span> </td> </tr> <tr> <th class="jh-key jh-object-key">minimalVersion</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">12.1.23</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">parameters</th> <td class="jh-value jh-object-value"> <table class="jh-type-array"> <tbody class=""> <tr> <th class="jh-key jh-array-key">0</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">requestBody</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">content</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">application/json</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">schema</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/SystemParameter_1_000.json#/definitions/ParameterInfo</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Parâmetro para ser incluido</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">responses</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">200</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Operação realizada com sucesso</span> </td> </tr> <tr> <th class="jh-key jh-object-key">content</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">application/json</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">schema</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/SystemParameter_1_000.json#/definitions/PagedParameters</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">400</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">erro no momento da Inclusão</span> </td> </tr> <tr> <th class="jh-key jh-object-key">content</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">application/json</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">schema</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">/systemParameters/{systemParameterId}</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">put</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">tags</th> <td class="jh-value jh-object-value"> <table class="jh-type-array"> <tbody class=""> <tr> <th class="jh-key jh-array-key">0</th> <td class="jh-value jh-array-value"> <span class="jh-type-string">System Parameters</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">summary</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Altera o parâmetro passado na requisição</span> </td> </tr> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Altera o parâmetro passado na requisição</span> </td> </tr> <tr> <th class="jh-key jh-object-key">operationId</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">postParameterId</span> </td> </tr> <tr> <th class="jh-key jh-object-key">x-totvs</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">productInformation</th> <td class="jh-value jh-object-value"> <table class="jh-type-array"> <tbody class=""> <tr> <th class="jh-key jh-array-key">0</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">product</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Protheus</span> </td> </tr> <tr> <th class="jh-key jh-object-key">available</th> <td class="jh-value jh-object-value"> <div> <span class="jh-type-bool-true">true</span> </div> </td> </tr> <tr> <th class="jh-key jh-object-key">note</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Este verbo esta disponivel com todos os parametros</span> </td> </tr> <tr> <th class="jh-key jh-object-key">minimalVersion</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">12.1.23</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">parameters</th> <td class="jh-value jh-object-value"> <table class="jh-type-array"> <tbody class=""> <tr> <th class="jh-key jh-array-key">0</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">#/components/parameters/ParameterId</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-array-key">1</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">requestBody</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">content</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">application/json</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">schema</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/SystemParameter_1_000.json#/definitions/ParameterInfo</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Parâmetro para ser incluído</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">responses</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">200</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Operação realizada com sucesso</span> </td> </tr> <tr> <th class="jh-key jh-object-key">content</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">application/json</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">schema</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/SystemParameter_1_000.json#/definitions/ParameterInfo</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">400</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">erro no momento da Inclusão</span> </td> </tr> <tr> <th class="jh-key jh-object-key">content</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">application/json</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">schema</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">404</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Parâmetro não localizado na base</span> </td> </tr> <tr> <th class="jh-key jh-object-key">content</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">application/json</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">schema</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">delete</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">tags</th> <td class="jh-value jh-object-value"> <table class="jh-type-array"> <tbody class=""> <tr> <th class="jh-key jh-array-key">0</th> <td class="jh-value jh-array-value"> <span class="jh-type-string">System Parameters</span> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">summary</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Exclusão de parâmetro da base</span> </td> </tr> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Exclusão de parâmetro da base</span> </td> </tr> <tr> <th class="jh-key jh-object-key">operationId</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">DeleteParameterId</span> </td> </tr> <tr> <th class="jh-key jh-object-key">x-totvs</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">productInformation</th> <td class="jh-value jh-object-value"> <table class="jh-type-array"> <tbody class=""> <tr> <th class="jh-key jh-array-key">0</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">product</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Protheus</span> </td> </tr> <tr> <th class="jh-key jh-object-key">available</th> <td class="jh-value jh-object-value"> <div> <span class="jh-type-bool-true">true</span> </div> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">parameters</th> <td class="jh-value jh-object-value"> <table class="jh-type-array"> <tbody class=""> <tr> <th class="jh-key jh-array-key">0</th> <td class="jh-value jh-array-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">#/components/parameters/ParameterId</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">responses</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">200</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Operação realizada com sucesso</span> </td> </tr> <tr> <th class="jh-key jh-object-key">content</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">application/json</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">schema</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/SystemParameter_1_000.json#/definitions/ParameterInfo</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">405</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Não disponivel</span> </td> </tr> <tr> <th class="jh-key jh-object-key">content</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">application/json</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">schema</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">$ref</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">components</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">parameters</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">ParameterId</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">name</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">systemParameterId</span> </td> </tr> <tr> <th class="jh-key jh-object-key">in</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">path</span> </td> </tr> <tr> <th class="jh-key jh-object-key">required</th> <td class="jh-value jh-object-value"> <div> <span class="jh-type-bool-true">true</span> </div> </td> </tr> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Identificador Único representando o parâmetro</span> </td> </tr> <tr> <th class="jh-key jh-object-key">schema</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">type</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">string</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">Codes</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">name</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">codes</span> </td> </tr> <tr> <th class="jh-key jh-object-key">in</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">query</span> </td> </tr> <tr> <th class="jh-key jh-object-key">description</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">Códigos de parâmetros retornados pelo get separado por vírgula (,) </span> </td> </tr> <tr> <th class="jh-key jh-object-key">required</th> <td class="jh-value jh-object-value"> <div> <span class="jh-type-bool-false">false</span> </div> </td> </tr> <tr> <th class="jh-key jh-object-key">example</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">param1,param2</span> </td> </tr> <tr> <th class="jh-key jh-object-key">schema</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">type</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">string</span> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> <tr> <th class="jh-key jh-object-key">Description</th> <td class="jh-value jh-object-value"> <table class="jh-type-object"> <tbody class=""> <tr> <th class="jh-key jh-object-key">name</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">description</span> </td> </tr> <tr> <th class="jh-key jh-object-key">in</th> <td class="jh-value jh-object-value"> <span class="jh-type-string">query</span> </td> </tr> <tr>
            
<th class="jh-key jh-object-key">description</th>
"codColigada": 2,
            "idTurmaDisc": 572,
            
<td class="jh-value jh-object-value">
"codEtapa": 1,
            
<span class="jh-type-string">Busca de descrição do paramêtro</span>
"dataInicio": "2024-01-01T00:00:00-03:00",
            
</td> </tr>
"dataFim": "2024-01-31T00:00:00-03:00",
            "tipoEtapa": "N",
            "pontosDistribuidos": 100.0000,
  
<tr>
          "media": 60.0000,
            "permiteDigitacaoNaEtapa": false,
      
<th
 
class="jh-key
 
jh-object-key">required</th>
    "etapaFinal": false,
            "etapaEncerrada": false
        },
    
<td
 
class="jh-value
 
jh-object-value">
  {
            "codColigada": 2,
            "idTurmaDisc": 572,
    
<div>
        "codEtapa": 2,
            "dataInicio": "2024-01-01T00:00:00-03:00",
            
<span class="jh-type-bool-false">false</span>
"dataFim": "2024-12-31T00:00:00-03:00",
            "tipoEtapa": "N",
            
</div>
"pontosDistribuidos": 100.0000,
            
"media": 60.0000,
            
</td>
"permiteDigitacaoNaEtapa": false,
            "etapaFinal": false,
            
</tr>
"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
/api/integracoes/v2/sesc/educacional/etapa/2|572|1|N
Bloco de código
languagejs
themeMidnight
titleRetorno
collapsetrue
{
    "codColigada": 2,
    "idTurmaDisc": 572,
    
<tr>
"codEtapa": 1,
    "dataInicio": "2024-01-01T00:00:00-03:00",
    
"dataFim": "2024-01-31T00:00:00-03:00",
    "tipoEtapa": "N",
    "pontosDistribuidos": 100.0000,
    
<th class="jh-key jh-object-key">example</th>
"media": 60.0000,
    "permiteDigitacaoNaEtapa": false,
    "etapaFinal": false,
    "etapaEncerrada": false
}
Expandir
titlePlano de Aula
HTML
<div 
class="get">GET</div>
<div class="endereco">/api/integracoes/v2/sesc/educacional/planodeaula</div>


Para buscar os planos de aula no SGE, o filtro da busca deve ser passado via QueryString.

codColigada: Coligada da Turma/Disciplina no RM

idTurmaDisc: Id da Turma/Disciplina no RM


Image Added


Bloco de código
languagejs
themeMidnight
titleExemplo
/api/integracoes/v2/sesc/educacional/planodeaula/?codColigada=2&idTurmadisc=572
Bloco de código
languagejs
themeMidnight
titleResposta
collapsetrue
{
    "hasNext": false,
    
<td class="jh-value jh-object-value">
"items": [
        {
            "codColigada": 2,
           
<span
 
class="jh-type-string">Parâmetro de busca</span>
"idTurmaDisc": 572,
            "idPlanoAula": 23293,
            
</td>
"numeroAula": 1,
            "dataPlanoAula": "2024-04-04T00:00:00-03:00",
            
</tr>
"confirmado": false,
            
<tr>
"aulaOnline": "http//:opopopoo",
            
<th class="jh-key jh-object-key">schema</th>
"conteudoPrevisto": "aula",
            "conteudoRealizado": "fez 
a aula",
            
<td class="jh-value jh-object-value">
"dataEfetiva": "2025-04-04T00:00:00-03:00",
            "licaoDeCasa": "para casa via patch",
            "observacao": 
<table class="jh-type-object">
"via patch",
            "horaInicial": "07:00",
            "horaFinal": "07:50"
        
<tbody class="">
},
        {
            "codColigada": 2,
            
<tr>
"idTurmaDisc": 572,
            "idPlanoAula": 23294,
            "numeroAula": 2,
            
<th class="jh-key jh-object-key">type</th>
"dataPlanoAula": "2024-04-04T00:00:00-03:00",
            "confirmado": false,
            "aulaOnline": "",
            
<td class="jh-value jh-object-value">
"conteudoPrevisto": "",
            
"conteudoRealizado": "",
            
<span class="jh-type-string">string</span>
"licaoDeCasa": "",
            "observacao": "",
            "horaInicial": "07:50",
            
</td>
"horaFinal": "08:40"
        }
    ]
}
HTML
<div class="post">PATCH</div>
<div class="endereco">/api/integracoes/v2/sesc/educacional/planodeaula</div>


Para atualizar os dados de um plano de aula (importação de conteúdo realizado) os dados da chave do registro devem ser passados na URL separados por pipeline "|" e os campos a serem atualizados devem ser enviados no corpo da requisição.

Como chave do campo devem ser passados o codColigada, idTurmaDisc, idPlanoAula.


Bloco de código
languagejs
themeMidnight
titleExemplo URL requisição de atualização de plano de aula
/api/integracoes/v2/sesc/educacional/planodeaula/2|572|23293
Bloco de código
languagejs
themeMidnight
titleExemplo do copo da requisição de atualização de plano de aula
collapsetrue
{
    "numeroAula": 1,
    "dataPlanoAula": "2024-04-04T00:00:00-03:00",
    "dataEfetiva": "2025-04-04",
    "confirmado": false,
	"aulaOnline": "url da aula",
    "conteudoPrevisto": "conteudo previsto",
    "conteudoRealizado": "conteudo realizado",
    "licaoDeCasa": "para casa via patch",
    "observacao": "via patch"
}
Bloco de código
languagejs
themeMidnight
titleExemplo de retorno da atualização de plano de aula
collapsetrue
{
    "codColigada": 2,
    "idTurmaDisc": 572,
    "idPlanoAula": 23293,
    "numeroAula": 1,
    "dataPlanoAula": "2024-04-04T00:00:00-03:00",
    "confirmado": false,
    "dataEfetiva": "2025-04-04T00:00:00-03:00",
    "licaoDeCasa": "para casa via patch",
    "observacao": "via patch"
}



HTML
<style>
	.expand-control {
    	cursor: pointer;
    	text-decoration: none;
	    margin-bottom: 10px;
	    background-color: #ededed;
	    height: 20px;
	    font-size: 15px;
	    padding: 5px;
	}
	.expand-control-text {
    	vertical-align: top;
	    font-weight: bold;
		color: #242424;
	}
	.post {
    	background-color: #378000;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.get {
    	background-color: #004fd6;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.put {
    	background-color: #ffa200;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.delete {
    	background-color: #cf0000;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.endereco{
		display: inline-block;
		padding: 5px;
		font-weight: bold;
	}
</style>
<!-- 
EXEMPLO DE MARCAÇÃO PARA TIPO DE REQUEST:
<div class="post">POST</div>
<div class="get">GET</div>
<div class="put">PUT</div>
<div class="delete">DELETE</div>

O ENDEREÇO DEVE SER INSERIDO COM A SEGUINTE MARCAÇÃO:
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/ItemContabil</div>
-->                       </tr>
                                  </tbody>
                                </table>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </td>
                    </tr>
                  </tbody>
                </table>
              </td>
            </tr>
          </tbody>
        </table>
      </td>
    </tr>
  </tbody>
</table>