Para acesso ao web service, é necessário solicitar a inclusão de um usuário com as permissões necessárias, a inclusão desse usuário deve ser solicitado a empresa que disponibiliza o web service.
Para o correto funcionamento deve-se armazenar e fornecer o token recebido no método de autenticação a cada nova requisição.
Todos os métodos devem ser executados enviando o atributo 'Content-type: application/json' no cabeçalho http.
Todos os métodos devem ser executados enviando o atributo 'token: d5333225-120c-4ed2-a06f-b01dfd96d79e' (token recebido na autenticação) no cabeçalho http, exceto no método de autenticação. Observacao - o token 'd5333225-120c-4ed2-a06f-b01dfd96d79e' é meramente ilustrativo.
Deve-se avaliar o atributo 'tokenExpiration' para saber até quando o token é válido, a definição de tempo para expirar é definido pelo provedor do serviço.
LOGIN
url: https://webservices.prorepresentacao.com.br/login.php
Envio :
usuario - Obrigatório
senha - Obrigatório
Retorno:
token - Campo deveerá ser guardo para os próximos acessos, até a expiração
tokenexpiration - Data de expiração do Token, após esta data e hora, renovar o token, formato: 2023-06-01 18:00:00
API
cabeçalho: "token: "+Token armazenado;
url: https://webservices.prorepresentacao.com.br/api.php
-
Usuários
Acesso ao cadastro de usuários do sistema
Envio:
fnc - 'usuarios' // Obrigatório para esta função
dtalt - '2023-06-20 10:00:00' // Filtro opcional de Data e Hora da última alteração
Retorno:
id - Campo com o ID do Usuário no sistema
nome - Campo com o Nome do usuário
sobrenome - Campo com o Sobrenome do usuário
email - Campo com o E-mail do usuário
telefone - Campo com o telefone do usuário
ativo - ( 'S' para ativo, 'N' para inativo )
dtalt - Campo com a data e hora da última alteração. Formato '2023-06-20 10:05:01'
-
Produtos
Acesso ao cadastro de produtos do sistema
Envio:
fnc - 'produtos' // Obrigatório para esta função
dtalt - '2023-06-20 10:00:00' // Filtro opcional de Data e Hora da última alteração
Retorno:
id - Campo com o ID do produto no sistema
ctg_id - Campo com o ID da categoria do produto no sistema
nome - Campo com o Nome do produto
descricao - Campo com a Descrição do produto
qtd - Campo com a Quantidade do produto
preco - Campo com o Preço de Venda do produto
foto - Campo com o URL completo da foto do produto
codbarras - Campo com o Código de barras do produto
ativo - ( 'S' para ativo, 'N' para inativo )
dtalt - Campo com a data e hora da última alteração. Formato '2023-06-20 10:05:01'
-
Transportadoras
Acesso ao cadastro de transportadoras do sistema
Envio:
fnc - 'transportadoras' // Obrigatório para esta função
dtalt - '2023-06-20 10:00:00' // Filtro opcional de Data e Hora da última alteração
Retorno:
id - Campo com o ID da Transportadora no sistema
nome - Campo com o Nome da transportadora
cnpj - Campo com o CNPJ da transportadora
endereco - Campo com o Endereço completo
ativo - ( 'S' para ativo, 'N' para inativo )
dtalt - Campo com a data e hora da última alteração. Formato '2023-06-20 10:05:01'
-
Categorias
Acesso ao cadastro de categorias do sistema
Envio:
fnc - 'categorias' // Obrigatório para esta função
dtalt - '2023-06-20 10:00:00' // Filtro opcional de Data e Hora da última alteração
Retorno:
id - Campo com o ID da Categoria no sistema
nome - Campo com o Nome da Categoria
ativo - ( 'S' para ativo, 'N' para inativo )
dtalt - Campo com a data e hora da última alteração. Formato '2023-06-20 10:05:01'
-
Clientes
Acesso ao cadastro de clientes do sistema
Envio:
fnc - 'clientes' // Obrigatório para esta função
dtalt - '2023-06-20 10:00:00' // Filtro opcional de Data e Hora da última alteração
Retorno:
id - Campo com o ID do cliente no sistema
usu_id - Campo com o ID do Usuário dono do Cliente
nome - Campo com o Nome do cliente
cnpj - Campo com o CNPJ
ie - Campo com a IE
email - Campo com o E-mail
endereco - Campo com o Endereço
complemento - Campo com o Complemento do Endereço
bairro - Campo com o Bairro
cidade - Campo com a Cidade
estado - Campo com o Estado
cep - Campo com o Cep
tipo_entrega - Campo com o Tipo da entrega sendo ( T=Transportadora ou R=Retira )
tipo_transportadora - Se Transportadora, tipo de entrega sendo ( C=Coleta ou E=Entrega )
obs_entrega - Campo com a Observação da Entrega
nome_transportadora - Se Transportadora, Campo com o Nome da Transportadora
cnpj_transportadora - Se Transportadora, Campo com o CNPJ da Transportadora
telefone_transportadora - Se Transportadora, Campo com o Telefone da Transportadora
email_transportadora - Se Transportadora, Campo com o Email da Transportadora
contato_transportadora - Se Transportadora, Campo com o Contato da Transportadora
endereco_transportadora - Se Transportadora, Campo com o Endereço da Transportadora
complemento_transportadora - Se Transportadora, Campo com o Complemento de Endereço da Transportadora
bairro_transportadora - Se Transportadora, Campo com o Bairro da Transportadora
cidade_transportadora - Se Transportadora, Campo com a Cidade da Transportadora
estado_transportadora - Se Transportadora, Campo com o ID do Estado da Transportadora
cep_transportadora - Se Transportadora, Campo com o CEP da Transportadora
tipo_NF - ( 'E' para 'Especial Desconto', 'N' para 'Normal' )
ativo - ( 'S' para ativo, 'N' para inativo )
dtalt - Campo com a data e hora da última alteração. Formato '2023-06-20 10:05:01'
-
Formas de Pagamento
Acesso ao cadastro de formas de pagamento do sistema
Envio:
fnc - 'formaspagamento' // Obrigatório para esta função
Retorno:
id - Campo com o ID da forma de pagamento no sistema
nome - Campo com o Nome da Forma de pagamento
ativo - ( 'S' para ativo, 'N' para inativo )
-
Estados
Acesso ao cadastro de Estados do sistema
Envio:
fnc - 'estados' // Obrigatório para esta função
dtalt - '2023-06-20 10:00:00' // Filtro opcional de Data e Hora da última alteração
Retorno:
id - Campo com o ID do Estado no sistema
estado - Campo com o Estado
uf - Campo com a UF
ativo - ( 'S' para ativo, 'N' para inativo )
-
Pedidos
Acesso ao cadastro de Pedidos do sistema
Envio:
fnc - 'pedidos' // Obrigatório para esta função
dtalt - '2023-06-20 10:00:00' // Filtro opcional de Data e Hora da última alteração
id - Filtro opcional de ID
Retorno:
id - Campo com o ID do Pedido no sistema
data - Campo com a Data do pedido formato: '2023-06-20'
cli_id - Campo com o ID do Cliente no sistema
ven_id - Campo com o ID do Vendedor no sistema
obs_deposito - Campo com a Observação do Depósito
tipo_nf - Campo com o Tipo de NF sendo ( E=Especial ou N=Normal )
endereco_pedido - Campo com o Endereço do Pedido
complemento_pedido - Campo com o Complemento do Endereço do Pedido
bairro_pedido - Campo com o Bairro do Pedido
cidade_pedido - Campo com a Cidade do Pedido
estado_pedido - Campo com o ID do Estado no sistema
cep_pedido - Campo com o CEP do Pedido
tipo_entrega - Campo com o Tipo da entrega sendo ( T=Transportadora ou R=Retira )
tipo_transportadora - Se Transportadora, tipo de entrega sendo ( C=Coleta ou E=Entrega )
obs_entrega - Campo com a Observação da Entrega
nome_transportadora - Se Transportadora, Campo com o Nome da Transportadora
cnpj_transportadora - Se Transportadora, Campo com o CNPJ da Transportadora
telefone_transportadora - Se Transportadora, Campo com o Telefone da Transportadora
email_transportadora - Se Transportadora, Campo com o Email da Transportadora
contato_transportadora - Se Transportadora, Campo com o Contato da Transportadora
endereco_transportadora - Se Transportadora, Campo com o Endereço da Transportadora
complemento_transportadora - Se Transportadora, Campo com o Complemento de Endereço da Transportadora
bairro_transportadora - Se Transportadora, Campo com o Bairro da Transportadora
cidade_transportadora - Se Transportadora, Campo com a Cidade da Transportadora
estado_transportadora - Se Transportadora, Campo com o ID do Estado da Transportadora
cep_transportadora - Se Transportadora, Campo com o CEP da Transportadora
endereco_entrega - Campo com o Endereço da Entrega
complemento_entrega - Campo com o Complemento do Endereço da Entrega
bairro_entrega - Campo com o Bairro da Entrega
cidade_entrega - Campo com a Cidade da Entrega
estado_entrega - Campo com o ID do Estado da Entrega
cep_entrega - Campo com o CEP da Entrega
nf - Campo com o Número da NF
valor_nf - Campo com o Valor da NF
cancelado - Pedido cancelado sendo ( S=Sim ou N=Não )
status - Campo com o Status do pedido sendo ( I=Incluído, D=Enviado ao Depósito, C=Coletado e F=Finalizado )
dtalt - Campo com a data e hora da última alteração. Formato '2023-06-20 10:05:01'
itens - Array com os itens do pedido {
pro_id - Campo com o ID do produto no sistema
quantidade - Campo com a Quantidade do produto
valor - Campo com o Valor do Produto
}
-
Status de Pedido
Acesso aos Status dos Pedidos do sistema
Envio:
fnc - 'status_pedido' // Obrigatório para esta função
dtalt - '2023-06-20 10:00:00' // Filtro opcional de Data e Hora da última alteração
Retorno:
ped_id - Campo com o ID do Pedido no sistema
status - Campo com o Status do pedido sendo ( I=Incluído, D=Enviado ao Depósito, C=Coletado e F=Finalizado )
dtalt - Campo com a data e hora da última alteração. Formato '2023-06-20 10:05:01'
-
Salvar Cliente
Salvar um Cliente Novo do sistema
Envio:
fnc - 'salvar_cliente' // Obrigatório para esta função
usu_id - Campo obrigatório com o id do Usuário do Sistema
nome - Campo obrigatório com o Nome do Cliente ( 200 )
cnpj - '99.999.999/9999-99' // Obrigatório se não tiver CPF. Campo com Formatação ( 18 )
cpf - '999.999.999-99' // Obrigatório se não tiver CNPJ. Campo com formatação ( 14 )
ie - Campo opcional Com a IE do Cliente( 50 )
telefone - '(99) 9999-9999' // Obrigatório se não tiver Celular. Campo com formatação( 14 )
celular - '(99) 9 9999-9999' // Obrigatório se não tiver Telefone. Campo com formatação( 16 )
email - 'joao@adm.com' // Campo obrigatório. Campo com Formatação ( 200 )
contato - Campo obrigatório com o Nome do Contato do Cliente ( 200 )
endereco - Campo obrigatório com o Endereço e Número do Cliente ( 300 )
complemento - Campo opcional com o Complemento do Endereço do Cliente ( 200 )
bairro - Campo obrigatório com o Bairro do Cliente ( 100 )
cidade - Campo obrigatório com a Cidade do Cliente ( 100 )
est_id - Campo obrigatório com o ID do Estado do Cliente
cep - '99999-999' // Campo obrigatório. Campo com Formatação ( 9 )
obs - Campo opcional com Obs do Cliente ( 500 )
Retorno:
cli_id - Campo com o ID do Cliente salvo se Sucesso
erro - Não Salvo, mensagem de Erro
-
Salvar Pedido
Salvar um Pedido Novo do sistema
Envio:
fnc - 'salvar_pedido' // Obrigatório para esta função
usu_id - Campo obrigatório com o id do Usuário do Sistema
data - '2023-12-31' // Campo obrigatório com a data do pedido
cli_id - Campo obrigatório com o id do Cliente do Sistema
dep_obs - Campo opcional com observação para o Depósito
endereco - Campo obrigatório com o Endereço e Número do Pedido ( 300 )
complemento - Campo opcional com o Complemento do Endereço do Pedido ( 200 )
bairro - Campo obrigatório com o Bairro do Pedido ( 100 )
cidade - Campo obrigatório com a Cidade do Pedido ( 100 )
est_id - Campo obrigatório com o ID do Estado do Pedido
cep - '99999-999' // Campo obrigatório. Campo com Formatação ( 9 )
tipo_nf - // Campo obrigatório . Campo com o Tipo de NF sendo ( E=Especial ou N=Normal )
ent_tipo - Campo obrigatório. Sendo ( 'T' entrega via transportadora ou 'R' Retira )
ent_trptipo - Campo obrigatório se ent_tipo for 'T'. Sendo ( 'C' Coleta ou 'E' Entrega )
ent_obs - Campo opcional com observação para a Entrega
trp_nome - Campo obrigatório se ent_tipo for 'T' com o Nome da Transportadora ( 200 )
trp_cnpj - '99.999.999/9999-99' // Obrigatório se ent_tipo for 'T'. Campo com Formatação ( 18 )
trp_telefone - '(99) 9999-9999' // Opcional se ent_tipo for 'T'. Campo com formatação( 14 )
trp_email - 'joao@adm.com' // Campo obrigatório se ent_tipo for 'T'. Campo com Formatação ( 200 )
trp_contato - Campo obrigatório se ent_tipo for 'T' com o Nome do Contato da Transportadora ( 200 )
trp_endereco - Campo obrigatório se ent_tipo for 'T' com o Endereço e Número do Cliente ( 300 )
trp_complemento - Campo opcional se ent_tipo for 'T' com o Complemento do Endereço da Transportadora ( 200 )
trp_bairro - Campo obrigatório se ent_tipo for 'T' com o Bairro da Transportadora ( 100 )
trp_cidade - Campo obrigatório se ent_tipo for 'T' com a Cidade da Transportadora ( 100 )
trp_est_id - Campo obrigatório se ent_tipo for 'T' com o ID do Estado da Transportadora
trp_cep - '99999-999' // Campo obrigatório se ent_tipo for 'T'. Campo com Formatação ( 9 )
ent_endereco - Campo obrigatório com o Endereço e Número da Entrega ( 300 )
ent_complemento - Campo opcional com o Complemento do Endereço da Entrega ( 200 )
ent_bairro - Campo obrigatório com o Bairro da Entrega ( 100 )
ent_cidade - Campo obrigatório com a Cidade da Entrega ( 100 )
ent_est_id - Campo obrigatório com o ID do Estado da Entrega
ent_cep - '99999-999' // Campo obrigatório. Campo com Formatação ( 9 )
nf - Campo opcional com a NF do pedido ( 100 )
valor_nf - '1234.00' // Campo opcional com o Valor da NF
itens - Array com os Itens do pedido
pro_id - Campo obrigatório com o ID do Produto
quantidade - Campo obrigatório com a Quantidade do Produto
valor - '1234.00' // Campo obrigatório com o valor unitário do Produto
parcelas - Array com as Parcelas de Pagamento do pedido
fpg_id - Campo obrigatório com o ID da Forma de Pagamento
vencimento - '2023-12-31' // Campo obrigatório com o Vencimento da Parcela
valor - '1234.00' // Campo obrigatório com o valor da Parcela
Retorno:
ped_id - Campo com o ID do Pedido salvo se Sucesso
erro - Não Salvo, mensagem de Erro