Início

Esta API foi desenvovida com base nas MIT044 relatadas abaixo de cada Endpoint

Para usar essa API você precisa de um Token.
Utilize o endpoint Login para conseguir um Token

Login

Tipo de autorização: Bearer token, utilizer o verbo post no endpoint
integracaoprotheus.unialfa.com.br/api/login
passando o seguintes parametros:
{
"email": "email@unialfa.com.br",
"password": "senhafornecida"
}

Endpoint cliente

Para obter a listagem dos novos clientes e dos clientes com alteração utilize o verbo GET na url :
http://integracaoprotheus.unialfa.com.br/api/cliente

Para confirmar a inclusão do cliente utilize o verbo PUT na url :
http://integracaoprotheus.unialfa.com.br/api/cliente

MIT044 - Especificação de Personalização – Integração Cliente RW Saga e Liceu 25/01/2021

Parâmetros de consulta (GET)

Campo	Tipo	Descrição
secret_key	String	sua API key.

Retorno

Campo	Tipo	Descrição
cpfcnpj	String	CPF do cliente.
matricula	String	Matrícula do cliente.
nome	String	Nome do cliente.
pessoa	String	(F-Fisica, J-Juridica)
tipo	String	(F-Final, R-Revenda)
datanasc	String	Data de nascimento formato YYYYMMDD
email	String	E-mail
ddd	String	DDD
fone	String	Número do telefone
produtofat	String	Código do produto faturado
inscmun	String	Inscrição Municipal (ISENTO para pessoa física)
inscest	String	Inscrição Estadual (ISENTO para pessoa física)
Rua	String	Nome da rua
Numero	String	Número da rua
Complemento	String	Complemento do endereço
bairro	String	Bairro do endereço
municipio	String	Nome do município
cep	String	CEP do endereço
estado	String	UF do endereço com dois caracteres
codmunicipio	String	Código IBGE do município
sistema	String	Código ou nome do sistema de origem do cliente (RWSaga ou Lyceum)

Parâmetros de Inclusão (PUT)

Campo	Tipo	Descrição
cpfcnpj	String	CPF do cliente
codigo	Integer	Código de retorno do Protheus
mensagem	String	Mensagem de retorno da inclusão no Protheus
sistema	String	Código ou nome do sistema de origem do cliente (RWSaga ou Lyceum)

Endpoint Títulos

Para obter a listagem dos novos títulos e dos títulos com alteração utilize o verbo GET na url :
http://integracaoprotheus.unialfa.com.br/api/titulo

Para confirmar a inclusão do titulo utilize o verbo PUT na url :
http://integracaoprotheus.unialfa.com.br/api/titulo

MIT044 - Especificação de Personalização – Integração de títulos RW Saga e Liceu 25/01/2021

Parâmetros de consulta (GET)

Campo	Tipo	Descrição
cpfcnpj	String	CPF do cliente
matricula	string	Matricula do cliente/aluno
nome	String	Nome do aluno
mesanoref	String	Mês e ano de referência formato mm/YYYY
valor	double	valor do título ex.: 1206.50
vencimento	String	Data de vencimento do título formato YYYYMMDD
banco	String	Identificação do banco ex.: 237
agencia	String	Número da agência
conta	String	Número da conta
nossonumero	String	Sequência númérica do nosso número (boleto/título)
dtdesconto1	String	Data desconto 1
valdesconto1	double	Valor do desconto para pagamento da data 1
dtdesconto2	String	Data desconto 2
valdesconto2	double	Valor do desconto para pagamento da data 2
dtdesconto3	String	Data desconto 3
valdesconto3	double	Valor do desconto para pagamento da data 3
bolsas	Objeto	Objeto bolsas, adiciona as bolsas e descontos que o aluno tem
codigo	String	Código da bolsa
descricao	String	Descrição da bolsa ex.: OVG
valor	double	Valor da bolsa ex.: 680.98
sistema	String	Código ou nome do sistema de origem do título (RWSaga ou Lyceum)

Parâmetros de Inclusão (PUT)

Campo	Tipo	Descrição
cpfcnpj	String	CPF do cliente
nossonumero	String	Sequencia do nosso número do título/boleto
codigo	integer	Código da mensagem Protheus
mensagem	String	Mensagem de retorno da inclusão no Protheus
sistema	String	Código ou nome do sistema de origem do cliente (RWSaga ou Lyceum)

Parâmetros de baixa de título (PUT) endpoint http://integracaoprotheus.unialfa.com.br/api/titulo/baixatitulo

Campo	Tipo	Descrição
cpfcnpj	String	CPF do cliente
nossonumero	Integer	Nosso número do boleto
databaixa	String	Data da baixa formato YYYYMMDD
valorbaixa	double	Valor da baixa
sistema	String	Código ou nome do sistema de origem do cliente (RWSaga ou Lyceum)
statuslan	String	Código do status de lançamento (RW)
contacaixabaixa	String	Código da conta caixa de baixa, caso a baixa seja manual no protheus

Parâmetros de baixa de título por liquidacao (PUT) endpoint http://integracaoprotheus.unialfa.com.br/api/titulo/liquidacao/{sistema}/{filial}

Campo	Tipo	Descrição
cpfcnpj	String	CPF do cliente
nossonumero	Integer	Nosso número do boleto
databaixa	String	Data da baixa formato YYYYMMDD
valorbaixa	double	Valor da baixa
statuslan	String	Código do status de lançamento (RW)
contacaixabaixa	String	Código da conta caixa de baixa, caso a baixa seja manual no protheus
numacordo	Int	Número identificador(Protheus) da liquidação
valoracordo	double	Valor da liquidação/negociação
boletoacordo	string	Identificador do nosso número bancário
parcelaacordo	string	Sequencial da parcela
valordescontoacordo	double	Valor do desconto da parcela
valorencargoacordo	double	Valor do encargo da parcela
periodoacordo	string	Semestre do acordo
vencimentoparcelaacordo	string	data vencimento do título da parcela do acordo

Errors

The Westeros API uses the following error codes:

Error Code	Meaning
X000	Some parameters are missing. This error appears when you don't pass every mandatory parameters.
X001	Unknown or unvalid secret_key. This error appears if you use an unknow API key or if your API key expired.
X002	Unvalid secret_key for this domain. This error appears if you use an API key non specified for your domain. Developper or Universal API keys doesn't have domain checker.
X003	Unknown or unvalid user token. This error appears if you use an unknow user token or if the user token expired.