Histórico da Página

Este documento tem por objetivo a documentar as API's disponíveis no projeto Integração UniSenai

Orientações gerais, autenticação e exemplos de consumo das API's.

Expandir

title	Autenticação

Deck of Cards

id	AutenticacaoAPI

Card

id	Basic
label	Basic

Authorization - Basic Auth

Username <username>

Password <password>

Card

id	Bearer
label	Bearer

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:

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.
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

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

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.

Requisição realizada na API de Usuário utilizando o token gerado:

Image Added

Verifique que a requisição foi realizada com sucesso e os dados foram apresentados corretamente.

Expandir

title	inscricaoCandidato

HTML
<div class="post">POST</div> <div class="endereco">/api/cst/v1/unisenai/processoseletivo/inscricaoCandidato</div>

Ao executar a chamada da API, serão realizadas as seguintes operações:

Criação do Usuário do Candidato no Processo Seletivo;

Inscrição do Candidato no Processo Seletivo;

Upload dos Documentos do Candidato;

Tabelas Afetadas: SPSUSUARIO, SPSINSCRICAOAREAOFERTADA, SPSARQUIVOSCANDIDATO

Interfaces RM:

TOTVS Educacional | Processo Seletivo | Cadastros | Usuário

TOTVS Educacional | Processo Seletivo | Cadastros | Processo Seletivo/ Venda Online de Cursos

TOTVS Educacional | Processo Seletivo | Cadastros | Processo Seletivo/ Venda Online de Cursos | Candidatos Inscritos

Bloco de código

language	c#
title	Raw

{
    "candidato":{
        "nome": "Regina Isabel Juliana Ramos",
        "dataNascimento": "1994-06-12",
        "cpf": "85755784647",
        "emailContato": "[email protected]",
        "celular": "31992211180",
        "estadoNatal": "MG",
        "naturalidade": "06200",
        "nacionalidade": 10,
        "numeroIdentidade": "160706567",
        "ufIdentidade": "MG",
        "emissaoIdentidade": "2002-01-01",
        "orgaoIdentidade": "SSP",
        "cep": "31360760",
        "tipoRua": 1,
        "rua": "Rua Geraldo Ludovico",
        "numero": "639",
        "complemento": "N/A",
        "tipoBairro": 1,
        "bairro": "Conjunto Confisco",
        "estado": "MG",
        "codMunicipio": "06200",
        "idPais": 1
    },
    "inscricao":{
        "coligada": 3,
        "filial": 3033,
        "idps": 6964,
		"formaInscricao": 1,
        "areaOfertada": 9522
    },
    "arquivosCandidato": [
        {
            "nomeArquivo": "arquivo1.pdf",
            "arquivo": 		"0x504B03041400000008000A80F856ED1D4C1F1D010000B904000011000000
4461646F73456E766961646F732E747874B593CB4AC3401486F785BEC39075C44C934C5377E2DE95B809A19C4E4E
213A37E6622BE2BB9BD45682197061BA19CE9C0BDF7F66F8EBE582908FE12024790489C91D490ECEEB5754497ACE
3F8308A702D07559B5B8CB7183790B6DBBDA03EC78C9CA6253653CFB99787A37C300BDDC1FB4F2A8FC39AD821043
E1338DD3F74171DFE9880054568BAD0415406CBF2FC1A175B380A5D6ADC083B3E8FC5E5B097E2AE0C58D64FD0776
122FFB6E57674DDDC7D8B5CD8457CC8F1ADE2B86621B96CF4FE33A58175D2DCFCB2B6CE73BD9FF1E583F055256B0
D59A1559761D2CAAC896949594D2A2BA06D40567A2D05958F79CA38938008C111D87C19FB7831B52E2F1E8C7E1F1
669C873770DC76C6A7643C7A94E2D22EC56F47E57F085E2E9A2F504B010214001400000008000A80F856ED1D4C1F
1D010000B90400001100000000000000000000000000000000004461646F73456E766961646F732E747874504B05
0600000000010001003F0000004C0100000000"
        }
    ]}

Content

candidato

nome: Nome completo do Usuário no Processo Seletivo; (Campo Obrigatório);
dataNascimento: Data de Nascimento do Usuário no Processo Seletivo; (Campo Obrigatório);
cpf: CPF do Usuário no Processo Seletivo; (Campo Obrigatório);
emailContato: Email do Usuário no Processo Seletivo; (Campo Obrigatório);
celular: Telefone residencial do Usuário no Processo Seletivo; (Campo Obrigatório);
estadoNatal: Estado natal do Usuário no Processo Seletivo; (Campo Obrigatório); Valores possíveis: Campo CODETD da tabela GETD;
naturalidade: Naturalidade do Usuário no Processo Seletivo; (Campo Obrigatório); Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIO
nacionalidade: Nacionalidade do Usuário no Processo Seletivo; (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela PCODNACAO;
numeroIdentidade: Numero da Identidade do Usuário no Processo Seletivo;
ufIdentidade: Estado emissor da Identidade do Usuário no Processo Seletivo;
emissaoIdentidade: Data de emissão da Identidade do Usuário no Processo Seletivo;
orgaoIdentidade: Órgão emissor da identidade do Usuário no Processo Seletivo;
cep: CEP do endereço do Usuário no Processo Seletivo;
tipoRua: Tipo de Rua do Usuário no Processo Seletivo; Valores possíveis: Campo CODIGO da tabela DTIPORUA;
rua: Rua do endereço do Usuário no Processo Seletivo;
numero: Numero do endereço do Usuário no Processo Seletivo;
complemento: Complemento do endereço do Usuário no Processo Seletivo;
tipoBairro: Tipo de Bairro do endereço do Usuário no Processo Seletivo; Valores possíveis: Campo CODIGO da tabela DTIPOBAIRRO
bairro: Bairro do endereço do Usuário no Processo Seletivo;
estado: Estado do endereço do Usuário no Processo Seletivo; Valores possíveis: Campo CODETD da tabela GETD;
codMunicipio: Nome da Cidade do Endereço do Usuário no Processo Seletivo; Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIO
idPais: Id. do Pais do endereço do Usuário no Processo Seletivo; Valores possíveis: Campo IDPAIS da tabela GPAIS;

inscricao

coligada: Código da coligada do Processo Seletivo no SGE; (Campo Obrigatório);
filial: Código da filial do Processo Seletivo no SGE; (Campo Obrigatório);
idps: Id do Processo Seletivo no SGE; (Campo Obrigatório);
formaInscricao: Id da Forma de Inscrição do Processo Seletivo no SGE;
areaOfertada: Id da Area Ofertada do Processo Seletivo no SGE; (Campo Obrigatório);

arquivosCandidato

nomeArquivo: Nome do Arquivo com o formato. Ex: cpf.pdf;
codDocumento: Código do Documento no RM (SDOCUMENTO) para fazer a ligação do arquivo enviado com o documento exigido no processo seletivo.
arquivo: Conteúdo do arquivo no formato base64;

Retorno

Bloco de código

language	c#
title	Console

{
    "Status": "Sucesso",
    "Mensagem": "Inscrição do candidato realizada com sucesso!",
    "DadosCriados": {
        "coligada": 3,
        "filial": 3,
        "idps": 6964,
        "idAreaOfertada": 9522,
        "numeroInscricao": 0,
        "codUsuarioPS": 443021,
        "cpf": "85755784647"
		"nome": "Audrey O'Hara"
    },
    "DetalheErros": {
        "ExceptionType": null,
        "InnerException": null
    }
}

Content

Status: Situação do processamento da requisição; Valores possíveis: "Sucesso" = Quando todas as etapas foram inseridas com sucesso; "Erro" = Quando ocorre um erro na integração com o SGE;
Mensagem: Mensagem de retorno do consumo da requisição;
Dados Criados:
- coligada: Código da Coligada do Processo Seletivo
- filial: Código da Filial do Processo Seletivo.
- idps: Id. do Processo Seletivo.
- idAreaOfertada: Id da Area Ofertada do Processo Seletivo.
- numeroInscricao: Numero de Inscrição do Candidato no Processo Seletivo.
- codPessoaPS: Código do Usuário no Processo Seletivo (CODUSUARIOPS).
- cpf: CPF do Candidato.
- nome: Nome do Candidato

DetalheErros:
- ExceptionType: Tipo da exceção lançada pela API.
- InnerException: Conteúdo extra da exceção lançada pela API.

HTML

<style>
	.expand-control {
    	cursor: pointer;
    	text-decoration: none;
	    margin-bottom: 10px;
	    background-color: #ededed;
	    height: 30px;
	    font-size: 20px;
	    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>
-->

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Authorization - Basic Auth

Retorno