Sei sulla pagina 1di 6

Documentao API Rest TOTVS

URL API: http://localhost:8082/rest/


Mtodo Login
GET
Parmetros
usuario Tipo string
senha tipo string
Exemplo: http://htq.no-ip.info:8082/rest/login?usuario=admin&senha=
Mtodo Vendedores
GET
Parmetros
codigo Tipo string
Exemplo: http://htq.no-ip.info:8082/rest/vendedores?codigo=000002
Para retornar todos os vendedores basta executar
http://htq.no-ip.info:8082/rest/vendedores/1
Mtodo Pagamentos
GET
Parmetros
codigo Tipo string
Exemplo: http://htq.no-ip.info:8082/rest/pagamentos?codigo=001
Para retornar todos os pagamentos basta executar
http://htq.no-ip.info:8082/rest/pagamentos/1
Mtodo Produtos
GET
Parmetros
codigo Tipo string
Exemplo: http://htq.no-ip.info:8082/rest/produtos?codigo=001
Para retornar todos os produtos basta executar
http://htq.no-ip.info:8082/rest/produtos/1

Mtodo Clientes
GET
Parmetros
cgc Tipo string
Exemplo: http://htq.no-ip.info:8082/rest/clientes?cgc=84041722268
Para retornar todos os produtos basta executar
http://htq.no-ip.info:8082/rest/clientes/1
POST
Parmetros
string Tipo string
Estrutura de json:
{
"clientes": [{
"codigo": "",
"nome": "RAYLENE ALVARENGA DA",
"cgc": "00002449293",
"email": "raylenealvarenga23@gmail.com",
"cep": "69038190",
"numero": "31B",
"ddd": "92",
"telefone": "96144442",
"nascimento": "19840703"
}]
}
Para Incluso enviar sempre o codigo em branco.
Objeto nome tamanho mximo de 40 caracteres.
Objeto email tamanho mximo de 90 caracteres.
Mensagem de Retorno de Incluso:
{
"clientes": [{
"mensagem": "cliente incluido com sucesso",
"codigo": "060940",
"cgc": "00553150200",
"nome": "TAIANE RIBEIRO"
}]
}
Mensagem caso o CGC exista na Base de Dados:
{
"clientes": [{
"mensagem": "cgc j existe na base de dados",
"codigo": "060940",
"cgc": "00553150200",
"nome": "TAIANE RIBEIRO"
}]
}
2

PUT
Parmetros
string Tipo string
Estrutura de json:
{
"clientes": [{
"cgc": "00553150200",
"email": "bergpacheco@gmail.com",
"cep": "69063100",
"numero": "2094"
}]
}
Objeto email tamanho mximo de 90 caracteres.
Mensagem de Retorno de alterao:
{
"clientes": [{
"mensagem": "cliente alterado com sucesso",
"codigo": "060941",
"cgc": "00553150200",
"nome": "TAIANE RIBEIRO"
}]
}
Mensagem caso no entre nos critrios:
{
"clientes": "cliente nao precisa ser alterado!"
}
Os critrio para alterao email ou endereo para atualizao na base de dados.

Mtodo Pedidos
GET
Parmetros
filial Tipo string
pedido Tipo string
Exemplo: http://htq.no-ip.info:8082/rest/pedidos?filial=23&pedido=000001
Para retornar todos os pedidos basta executar
http://htq.no-ip.info:8082/rest/pedidos/1
POST
Parmetros
string Tipo string
Estrutura de json:
{
"pedido": {
"filial": "09",
"numero": "",
"tipo": "N",
"cliente": "060938",
"loja": "01",
"condicao": "001",
"pedidoItens": {
"itens": [{
"produto": "SAMS0067",
"quant": "1",
"preco": "3699",
"precoUnit": "3699",
"valor": "3699"
}]
}
}
}
Para Incluso enviar sempre o numero em branco.
Objeto valor sempre ser o preco x quant.
OBS: Sempre enviar valore como string;
Mensagem de Retorno de Incluso:
{
"pedido": [{
"mensagem": "pedido incluido com sucesso",
"filial": "23",
"numero": "000002"
}]
}

PUT
Parmetros
string Tipo string
Estrutura de json:
{
"pedido": {
"filial": "23",
"numero": "000001",
"tipo": "N",
"cliente": "060938",
"loja": "01",
"condicao": "001",
"pedidoItens": {
"itens": [{
"produto": "SAMS0067",
"quant": "1",
"preco": "3699.99",
"precoUnit": "3699.99",
"valor": "3699.99"
}, {
"produto": "TEL1068",
"quant": "3",
"preco": "1699.99",
"precoUnit": "1699.99",
"valor": "5099.97"
}]
}
}
}
Para Alterao sempre enviar numero preenchido com o numero do pedido a ser alterado.
Objeto valor sempre ser o preco x quant.
Mensagem de Retorno de alterao:
{
"pedido": [{
"mensagem": "pedido alterado com sucesso",
"filial": "23",
"numero": "000001"
}]
}
OBS.: Para gera o json de incluso ou alterao basta concatenar o GET de pedidos com GET de
itens.

Mtodo Itens de Pedido


GET
Parmetros
filial Tipo string
pedido Tipo string
Exemplo: http://htq.no-ip.info:8082/rest/itens?filial=23&pedido=000001

Potrebbero piacerti anche