Top

Api PortalERP

Esta Api contém os métodos e as URLs necessárias para consumir o conteúdo do sistema PortalERP. Está disponível 4 operações básicas para cada módulo, que são: listar todos os itens, cadastrar um item, editar os dados de um item e inativar um item. Por questões de segurança, o sistema PortalERP não faz a exclusão de nenhum item, apenas define-o como inativo, possibilitando assim a recuperação do mesmo, caso esta operação tenha sido feita de forma acidental.

Módulos

Módulo Atendimento

Contém os métodos de manipulação de um atendimento do sistema PortalERP.

Método(s)

listar

lista todos os atendimento cadastrados.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = atendimentos): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

id_atendimento: recebe o identificador do atendimento
num_zap_cliente: recebe o número do WhatsApp do cliente
status_atendimento: recebe o status do atendimento (A, P ou F)
nome_cliente: recebe o nome do cliente
dt_atendimento: recebe a data do atendimento (formato DD/MM/AAAA)
hr_atendimento: recebe o horário do atendimento (formato HH:MM)
id_usuario: recebe o identificador do usuário
id_setor: recebe o identificador do setor
dt_atendimento_fim: recebe a data de finalização do atendimento (format DD/MM/AAAA)
hr_atendimento_fim: recebe o horário de finalização do atendimento (formato HH:MM)
finalizado_por: recebe o nome de quem finalizou o atendimento
url_avatar: recebe a URL do avatar

Formato do retorno (JSON):

{
  "status": "OK" // Status de requisição bem sucedida,
  "data": [{ // Lista com os atendimentos retornados na pesquisa.
    "id_atendimento": "", // Identificador do atendimento
    "num_zap_cliente": "", // Número do WhatsApp do cliente
    "status_atendimento": "", // Status do atendimento
    "nome_cliente": "", // Ínome do cliente
    "dt_atendimento": "", // Data do atendimento
    "hr_atendimento": "", // Horário do atendimento
    "id_usuario": "", // Identificador do usuário
    "id_setor": "", // Identificador do setor
    "dt_atendimento_fim": "", // Data de finalização do atendimento
    "hr_atendimento_fim": "", // Horário de finalização do atendimento
    "finalizado_por": "", // Nome de quem finalizou o atendimento
    "url_avatar": "", // URL do avatar
  }]
}

criar

Método responsável pela criação de um atendimento.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = atendimentos): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

num_zap_cliente: <caracter>, número do WhatsApp do cliente, tamanho máximo = 15 (obrigatório)
status_atendimento: <caracter>, status do atendimento (A, P ou F), tamanho máximo = 1 (obrigatório)
nome_cliente: <caracter>, nome do cliente, tamanho máximo = 100
dt_atendimento: <caracter>, data do atendimento (formato DD/MM/AAAA) (obrigatório)
hr_atendimento: <caracter>, horário do atendimento (formato HH:MM) (obrigatório)
id_usuario: <inteiro>, identificador do usuário
id_setor: <inteiro>, identificador do setor
dt_atendimento_fim: <caracter>, data de finalização do atendimento (format DD/MM/AAAA)
hr_atendimento_fim: <caracter>, horário de finalização do atendimento (formato HH:MM)
finalizado_por: <caracter>, nome de quem finalizou o atendimento, tamanho máximo = 100
url_avatar: <caracter>, URL do avatar

Formato do retorno (JSON):

{
  "status": "OK",
  "id_atendimento": "",
  "mensagem": "Atendimento criado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar o atendimento. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de um atendimento já cadastrado.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = atendimentos): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_atendimento: <inteiro>, identificador do atendimento a ser editado, não pode ser alterado, (obrigatório)
num_zap_cliente: <caracter>, número do WhatsApp do cliente, tamanho máximo = 15 (obrigatório)
status_atendimento: <caracter>, status do atendimento (A, P ou F), tamanho máximo = 1 (obrigatório)
nome_cliente: <caracter>, nome do cliente, tamanho máximo = 100
dt_atendimento: <caracter>, data do atendimento (formato DD/MM/AAAA) (obrigatório)
hr_atendimento: <caracter>, horário do atendimento (formato HH:MM) (obrigatório)
id_usuario: <inteiro>, identificador do usuário
id_setor: <inteiro>, identificador do setor
dt_atendimento_fim: <caracter>, data de finalização do atendimento (format DD/MM/AAAA)
hr_atendimento_fim: <caracter>, horário de finalização do atendimento (formato HH:MM)
finalizado_por: <caracter>, nome de quem finalizou o atendimento, tamanho máximo = 100
url_avatar: <caracter>, URL do avatar

Formato do retorno (JSON):

{
  "status": "OK",
  "id_atendimento": "",
  "mensagem": "atendimento alterado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar o atendimento. Verifique os campos"
}

Módulo Atendimento Anexo

Contém os métodos de manipulação de um atendimento anexo do sistema PortalERP.

Método(s)

listar

lista todos os atendimentos anexos cadastrados.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = atendimentos_anexo): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

id_atendimento: recebe o identificador do atendimento anexo
num_zap_cliente: recebe o número do WhatsApp do cliente
sequencia: recebe a sequência do atendimento anexo
extensao: recebe a extensão do atendimento anexo
dt_msg: recebe a data do atendimento anexo (formato DD/MM/AAAA)
hr_msg: recebe o horário do atendimento anexo (formato HH:MM)
enviada: recebe o status de atendimento anexo enviada (0, 1)
entregue: recebe o status de atendimento anexo entregue (0, 1)
lida: recebe o status de atendimento anexo lida (0, 1)
idmsgnozap: recebe o identificador de atendimento anexo no zapmega

Formato do retorno (JSON):

{
  "status": "OK" // Status de requisição bem sucedida,
  "data": [{ // Lista com os atendimentos anexos retornados na pesquisa.
    "id_atendimento": "", // Identificador do atendimento anexo
    "num_zap_cliente": "", // Número do WhatsApp do cliente
    "sequencia": "", // Sequência do atendimento anexo
    "extensao": "", // Extensão do atendimento anexo
    "dt_msg": "", // Data do atendimento anexo
    "hr_msg": "", // Horário do atendimento anexo
    "enviada": "", // Status de atendimento anexo enviado
    "entregue": "", // Status de atendimento anexo entregue
    "lida": "", // Status de atendimento anexo lida
    "idmsgnozap": "", // Identificador do atendimento anexo no ZapMega
    "anexo_zap": "", // Anexo da mensagem, convertido em Base64
  }]
}

criar

Método responsável pela criação de um atendimento anexo.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = atendimentos_anexo): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_atendimento: <inteiro>, identificador do atendimento anexo a ser utilizado, (obrigatório)
num_zap_cliente: <caracter>, número do WhatsApp do cliente, tamanho máximo = 15 (obrigatório)
sequencia: <inteiro>, sequência do atendimento anexo (obrigatório)
extensao: <caracter>, estensão do anexo da mensagem, tamanho máximo = 50 (obrigatório)
anexo_zap: <caracter>, arquivo do atendimento anexo (obrigatório - deve ser enviado em base64)
dt_msg: <caracter>, data do atendimento anexo (formato DD/MM/AAAA) (obrigatório)
hr_msg: <caracter>, horário do atendimento anexo (formato HH:MM) (obrigatório)
enviada: <caracter>, status de atendimento anexo enviado, (0 ou 1)
entregue: <caracter>, status de atendimento anexo entregue, (0 ou 1)
lida: <caracter>, status de atendimento anexo lida, (0 ou 1)
notificada: <caracter>, status de atendimento mensagem notificada, (0 ou 1)
idmsgnozap: <caracter>, Identificador do anexo no atendimento, tamanho máximo = 50

Formato do retorno (JSON):

{
  "status": "OK",
  "sequencia": "",
  "mensagem": "Atendimento anexo criado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar o atendimento anexo. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de um atendimento anexo já cadastrado.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = atendimentos_anexo): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_atendimento: <inteiro>, identificador do atendimento anexo a ser utilizado, (obrigatório)
num_zap_cliente: <caracter>, número do WhatsApp do cliente, tamanho máximo = 15 (obrigatório)
sequencia: <inteiro>, sequência do atendimento anexo (obrigatório)
extensao: <caracter>, estensão do anexo da mensagem, tamanho máximo = 50 (obrigatório)
anexo_zap: <caracter>, arquivo do atendimento anexo (obrigatório - deve ser enviado em base64)
dt_msg: <caracter>, data do atendimento anexo (formato DD/MM/AAAA) (obrigatório)
hr_msg: <caracter>, horário do atendimento anexo (formato HH:MM) (obrigatório)
enviada: <caracter>, status de atendimento anexo enviado, (0 ou 1)
entregue: <caracter>, status de atendimento anexo entregue, (0 ou 1)
lida: <caracter>, status de atendimento anexo lida, (0 ou 1)
notificada: <caracter>, status de atendimento mensagem notificada, (0 ou 1)
idmsgnozap: <caracter>, Identificador do anexo no atendimento, tamanho máximo = 50

Formato do retorno (JSON):

{
  "status": "OK",
  "sequencia": "",
  "mensagem": "atendimento anexo alterado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar o atendimento anexo. Verifique os campos"
}

Módulo Atendimento Mensagem

Contém os métodos de manipulação de um atendimento mensagem do sistema PortalERP.

Método(s)

listar

lista todos os atendimentos mensagens cadastrados.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = atendimentos_msg): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

id_atendimento: recebe o identificador do atendimento mensagem
num_zap_cliente: recebe o número do WhatsApp do cliente
sequencia: recebe a sequência do atendimento mensagem
situacao: recebe a situação do atendimento mensagem (S, N)
msg: recebe a mensagem do atendimento mensagem
resp_msg: recebe a resposta da mensagem do atendimento mensagem
dt_msg: recebe a data do atendimento mensagem (formato DD/MM/AAAA)
hr_msg: recebe o horário do atendimento mensagem (formato HH:MM)
id_usuario: recebe o identificador do usuário
nome_chat: recebe o nome no chat do atendimento mensagem
enviada: recebe o status de atendimento mensagem enviada (0, 1)
entregue: recebe o status de atendimento mensagem entregue (0, 1)
lida: recebe o status de atendimento mensagem lida (0, 1)
notificada: recebe o status de atendimento mensagem notificada (0, 1)
idmsgnozap: recebe o identificador de atendimento anexo no zapmega
anexo: recebe o status de atendimento mensagem com anexo (0, 1)
horaunix: recebe o horário no formato Unix

Formato do retorno (JSON):

{
  "status": "OK" // Status de requisição bem sucedida,
  "data": [{ // Lista com os atendimentos mensagem retornados na pesquisa.
    "id_atendimento": "", // Identificador do atendimento mensagem
    "num_zap_cliente": "", // Número do WhatsApp do cliente
    "sequencia": "", // Sequência do atendimento mensagem
    "situacao": "", // Situação do atendimento mensagem
    "msg": "", // Mensagem do atendimento mensagem
    "resp_msg": "", // Resposta da mensagem do atendimento mensagem
    "dt_msg": "", // Data do atendimento mensagem
    "hr_msg": "", // Horário do atendimento mensagem
    "id_usuario": "", // Identificador do usuário
    "nome_chat": "", // Nome no chat do atendimento cliente
    "enviada": "", // Status de atendimento mensagem enviado
    "entregue": "", // Status de atendimento mensagem entregue
    "lida": "", // Status de atendimento mensagem lida
    "notificada": "", // Status de atendimento mensagem notificada
    "idmsgnozap": "", // Identificador do atendimento anexo no ZapMega
    "anexo": "", // Status de atendimento mensagem com anexo
    "horaunix": "", // Horário no formato Unix
  }]
}

criar

Método responsável pela criação de um atendimento mensagem.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = atendimentos_msg): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_atendimento: <inteiro>, identificador do atendimento mensagem a ser utilizado, (obrigatório)
num_zap_cliente: <caracter>, número do WhatsApp do cliente, tamanho máximo = 15 (obrigatório)
situacao: <caracter>, status do atendimento mensagem (S, N), tamanho máximo = 1 (obrigatório)
msg: <caracter>, mensagem do atendimento
resp_msg: <caracter>, resposta do atendimento mensagem
dt_msg: <caracter>, data do atendimento mensagem (formato DD/MM/AAAA) (obrigatório)
hr_msg: <caracter>, horário do atendimento mensagem (formato HH:MM) (obrigatório)
id_usuario: <inteiro>, identificador do usuário
nome_chat: <caracter>, nome no chato do atendimento mensagem, tamanho máximo = 100
enviada: <caracter>, status de atendimento mensagem enviado, (0 ou 1)
entregue: <caracter>, status de atendimento mensagem entregue, (0 ou 1)
lida: <caracter>, status de atendimento mensagem lida, (0 ou 1)
notificada: <caracter>, status de atendimento mensagem notificada, (0 ou 1)
idmsgnozap: <caracter>, Identificador do anexo no atendimento, tamanho máximo = 50
anexo: <caracter>, status de atendimento mensagem com anexo, (0 ou 1)
horaunix: <inteiro>, recebe o horário no formato Unix

Formato do retorno (JSON):

{
  "status": "OK",
  "sequencia": "",
  "mensagem": "Atendimento mensagem criado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar o atendimento mensagem. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de um atendimento mensagem já cadastrado.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = atendimentos_msg): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

sequencia: <inteiro>, sequência do atendimento mensagem a ser editado, não pode ser alterado, (obrigatório)
id_atendimento: <inteiro>, identificador do atendimento mensagem a ser utilizado, (obrigatório)
num_zap_cliente: <caracter>, número do WhatsApp do cliente, tamanho máximo = 15 (obrigatório)
situacao: <caracter>, status do atendimento mensagem (S, N), tamanho máximo = 1 (obrigatório)
msg: <caracter>, mensagem do atendimento
resp_msg: <caracter>, resposta do atendimento mensagem
dt_msg: <caracter>, data do atendimento mensagem (formato DD/MM/AAAA) (obrigatório)
hr_msg: <caracter>, horário do atendimento mensagem (formato HH:MM) (obrigatório)
id_usuario: <inteiro>, identificador do usuário
nome_chat: <caracter>, nome no chato do atendimento mensagem, tamanho máximo = 100
enviada: <caracter>, status de atendimento mensagem enviado, (0 ou 1)
entregue: <caracter>, status de atendimento mensagem entregue, (0 ou 1)
lida: <caracter>, status de atendimento mensagem lida, (0 ou 1)
notificada: <caracter>, status de atendimento mensagem notificada, (0 ou 1)
idmsgnozap: <caracter>, Identificador do anexo no atendimento, tamanho máximo = 50
anexo: <caracter>, status de atendimento mensagem com anexo, (0 ou 1)
horaunix: <inteiro>, recebe o horário no formato Unix

Formato do retorno (JSON):

{
  "status": "OK",
  "sequencia": "",
  "mensagem": "atendimento mensagem alterado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar o atendimento mensagem. Verifique os campos"
}

Módulo Autenticação

Responsável por realizar a autenticação na Api do PortalERP.

Método(s)

Faz o login na Api do PortalERP.

URL:

POST http://erp.addmob.com.br/api/login

Parâmetros:

username: recebe o nome do usuário;
password: recebe a senha de acesso. A senha deve estar criptografada, em formato de octeto de bits, separados por vírgula (ex: '01111101,01011100,01110010').

Formato do retorno (JSON):

{
  "status": "OK", // status de login realizado com sucesso
  "token": "<token_acesso>" // token de acesso, que deverá ser utilizado em todas as requisições
}
ou
{
  "status": "ERRO", // status de erro no login
  "mensagem": "Usuario ou senha invalidos" // mensagem de erro mo login
}

A senha precisa estar criptografada, utilizando o método de criptografia padrão do PortalERP. A senha criptografada consiste em um array de bits, no formato caracter.

Esta senha deve ser enviada como uma única String, separando os octetos por vírgula. Veja abaixo um exemplo de envio de requisição de login:

#código em Python
from requests import Request, Session
import requests

senha = "123"
senhaCriptografada = ['01111110', '00001111', '00110001']
senhaCriptografadaString = '01111110,00001111,00110001'
r = requests.session()
data = {
'username': 'teste', 'password': senhaCriptografadaString
}
url = "http://erp.addmob.com.br/api/login"
resp = r.post(url, data=data)

jsonResposta = json.loads(resp.text)
if jsonResposta["status"] == "OK":
token = jsonResposta["token"]

autenticando as requisições

Em todas as requisições de consumo dos dados desta API, o token de acesso deverá ser passando no header da requisição, seja ela GET, POST ou DELETE.

Exemplo de envio de requisição junto com o token de acesso:

#código em Python
import requests

url="http://erp.addmob.com.br/api/listar?url=grupos&parametros=[]"
requests.get(url, headers={'Authorization': '<token_acesso>'})

Módulo Autorização de Pedidos

Contém os métodos de manipulação da autorização de pedidos do sistema PortalERP.

Método(s)

listar

lista todas as autorizações de pedidos cadastradas.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = autorizacao_pedido): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

data_pedido: recebe a data e hora do pedido
email: recebe o e-mail
id_autorizacao: recebe o identificador do pedido
id_cliente: recebe o identificador do cliente do pedido
itens: recebe uma lista com os itens do pedido
nome_cliente: recebe o nome do cliente do pedido
senha_autorizacao: recebe a senha de autorização do pedido
status_autorizacao: recebe o status da autorização do pedido
valor_pedido: recebe o valor do pedido

Formato do retorno (JSON):

{
  "status": "OK", // Status de requisição bem sucedida,
  "data": [{// Lista com os dados dos pedidos retornados na pesquisa.
    "data_pedido": "", // Data e Hora do pedido (DD/MM/AAAA HH:MM)
    "email": "", // E-mail do cliente cadastrado no sistema
    "id_autorizacao": "", // Identificador do autorização do pedido
    "id_cliente": "", // Identificador do cliente do pedido
    "itens": { // Lista com as informaçãos dos produtos do pedido
       "1": { // Lista enumerada com os itens do pedido
         "id_produto": "", // Identificador do produto
         "nome_produto": "", // Nome do produto
         "preco": "", // Preço do produto
         "quantidade": "", // Quantidade do produto
       },
    },
    "nome_cliente": "", // Nome do cliente do pedido
    "senha_autorizacao": "", // Senha para de autorização do pedido
    "status_autorizacao": "", // Status da autorização do pedido
    "valor_pedido": "" // Valor total do pedido
  }]
}

criar

Método responsável pela criação de uma autorização de pedido.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = autorizacao_pedido): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_cliente: <caracter>, Identificador do cliente, (obrigatório - 11 dígitos)
data_pedido: <caracter>, Data e hora do pedido (obrigatório - DD/MM/AAAA HH:MM:SS)
valor_pedido: <decimal>, Valor do pedido, (obrigatório)
itens: <lista>, Lista com os itens do pedido, (obrigatório - "indice do produto (numérico)": {"id_produto": "(numérico)" , "quantidade": "(numérico)", "preco": "(decimal)" }, {...})

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Solicitação de Autorização realizada com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Autorização já foi solicitada"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao realizar o Pedido de Autorização. Verifique os campos"
}

gerar senha de autorização

Método responsável pela geração de senha de autorização de pedido.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = autorizacao_pedido): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_autorizacao: <inteiro>, Identificador da autorização , (obrigatório - 11 dígitos)
senha_autorizacao: <caracter>, Senha da autorização, (obrigatório - 6 dígitos)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Senha da Autorização modificada com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar a Senha da Autorização. Verifique os campos"
}

validar senha de autorização

Método responsável por validar a senha de autorização de pedidos.

URL:

POST http://erp.addmob.com.br/api/validar

Parâmetros:

url (valor = autorizacao_pedido): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_autorizacao: <inteiro>, Identificador da autorização , (obrigatório - 11 dígitos)
senha_autorizacao: <caracter>, Senha da autorização, (obrigatório - 6 dígitos)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Pedido Autorizado!"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao Autorizar Pedido. Verifique os campos"
}

Módulo Categorias

Contém os métodos de manipulação das categorias de produtos do sistema PortalERP.

Método(s)

listar

lista todas as categorias de produtos cadastradas.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Observação: Para listar apenas as categorias ativas, é obrigatório utilizar o parâmetro ativo igual a "sim" (ex: parametros=[ativo=sim])

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = categorias): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

id_categoria: recebe o identificador da categoria
nome_categoria: recebe o nome da categoria
ativo: recebe o status da categoria (padrão: sim ou nao)
possui_subcategorias: recebe o status de categorias que possuem subcategorias (padrão: sim ou nao)
id_pai: recebe o identicador do pai da categoria
imagem: recebe a imamgem da categoria
path: recebe a hierarquia da categoria ativa
cod_categoria_original: recebe o código da categoria do sistema Egestão
cod_subcategoria_original: recebe o código da subcategoria do sistema Egestão

Formato do retorno (JSON):

{
  "status": "OK", // Status de requisição bem sucedida,
  "data": [{// Lista com os dados das categorias retornadas na pesquisa.
    "id_categoria": "", // Identificador da categoria
    "nome_categoria": "", // Nome da categoria
    "ativo": "", // Status da categoria ativa (ATIVA ou INATIVA)
    "possui_subcategorias": "", // Status (S ou N) de categorias que possuem filhos(sub categorias)
    "id_pai": "", // ID pai
    "imagem": "", // Imagem
    "path": "", // Path
    "cod_categoria_original": "", // Código da categoria no sistema Egestão
    "cod_subgcategoria_original": "", // Código da subcategoria no sistema Egestão
  }]
}

criar

Método responsável pela criação de uma categoria.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = categorias): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

nome_categoria: <caracter>, Nome da categoria, tamanho máximo = 40 dígitos, (obrigatório)
ativo: <inteiro>, Status da categoria, (obrigatório - 0 ou 1)
id_pai: <inteiro>, Identificador do pai da categoria, (obrigatório - 11 dígitos), (default = 0)
cod_categoria_original: <inteiro>, Código da categoria original, (opcional - 3 dígitos)
cod_subcategoria_original: <inteiro>, Código da subcategoria original, (opcional - 3 dígitos)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Categoria de Produtos criada com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Ja existe uma Categoria de Produtos cadastrada com o mesmo cod_categoria_original e cod_subcategoria_original no esoft"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar a Categoria de Produtos. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de uma categoria já cadastrada.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = categorias): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_categoria: <inteiro>, Identificador da categoria, (obrigatório - 11 dígitos)
nome_categoria: <caracter>, Categorias, tamanho máximo = 40 dígitos, (obrigatório)
ativo: <inteiro>, Status da categoria, (obrigatório - 0 ou 1)
id_pai: <inteiro>, Identificador do pai, (obrigatório - 11 dígitos), (default = 0)
cod_categoria_original: <inteiro>, Código da categoria no sistema Egestão, (opcional - 3 dígitos)
cod_subcategoria_original: <inteiro>, Código da subcategoria no sistema Egestão, (opcional - 3 dígitos)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Categoria de Produtos alterada com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Ja existe uma Categoria de Produtos cadastrada com o mesmo cod_categoria_original e cod_subcategoria_original no esoft"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao editar a Categoria de Produtos. Verifique os campos"
}

ativar/inativar

Método responsável por ativar/inativar uma categoria de produtos.

URL:

DELETE http://erp.addmob.com.br/api/inativar

Parâmetros:

url (valor = categorias): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros obrigatórios (estes parâmetros são obrigatórios - formato [campo1=v1,campo2=v2]):

id_categoria: recebe o identificador da categoria
tipo: recebe a operação (ativar ou inativar)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Categoria de Produtos ativada/inativada com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao ativar/inativar a Categoria de Produtos"
}

Módulo Cliente

Contém os métodos de manipulação de um cliente do sistema PortalERP.

Método(s)

listar

lista todos os clientes cadastrados.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Observação: Para listar apenas os clientes ativos, é obrigatório utilizar o parâmetro ativo igual a "sim" (ex: parametros=[ativo=sim])

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = clientes): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

id_cliente: recebe o identificador do cliente
email: recebe o e-mail do cliente
celular: recebe o número do celular do cliente
nome_cliente: recebe o nome do cliente (Razão Social)
cpf_cnpj: recebe o CPF/CNPJ do cliente
inscricao_estadual: recebe a inscrição estadual do cliente
nome_fantasia: recebe o nome fantasia do cliente (pessoa jurídica) ou apelido (pessoa física)
endereco_principal: recebe o endereço do cliente
numero_endereco_principal: recebe o número do endereço do cliente
complemento_endereco_principal: recebe o complemento do endereço do cliente
bairro_endereco_principal: recebe o bairro do cliente
cidade_endereco_principal: recebe a cidade do cliente
estado_endereco_principal: recebe o nome do estado do cliente
cep_endereco_principal: recebe o cep do cliente
telefone: recebe o telefone fixo do cliente
instagram: recebe o endereço do perfil do Instagram do cliente
facebook: recebe o endereço do perfil do Facebook do cliente
imagem: recebe a foto do cliente
sexo: recebe o gênero do cliente
data_nascimento: recebe a data de nascimento do cliente (formato: DD/MM/AAAA)
total_pontos: recebe o total de pontos do cliente
categoria: recebe a categoria do cliente
nome_principal_vendedor: recebe o nome principal do vendedor do cliente
nome_principal_atendente: recebe o nome principal do atendente do cliente
aceita_mkt: recebe o status de usuário que aceita receber e-mail, promoções e whatsapp (padrão: sim ou nao)
nome_responsavel: recebe o nome do responsável do cliente, caso ele seja pessoa jurídica
cpf_responsavel: recebe o CPF do responsável do cliente, caso ele seja pessoa jurídica
ativo: recebe o status de cliente ativo (padrão: sim ou nao)
cod_clie_original: recebe o código do cliente, que é utilziando pelo esoft (caso este seja um cliente)
cod_forn_original: recebe o código do fornecedor, que é utilziando pelo esoft (caso este seja um fornecedor)
cod_tran_original: recebe o código da transportadora, que é utilziando pelo esoft (caso este seja uma transportadora)
cod_vend_original: recebe o código do vendedor, que é utilziando pelo esoft (caso este seja um vendedor)
considerar_cliente: recebe o status de cliente do tipo cliente (padrão: sim ou nao)
considerar_transportadora: recebe o status de cliente do tipo transportadora (padrão: sim ou nao)
considerar_fornecedor: recebe o status de cliente do tipo fornecedor (padrão: sim ou nao)
considerar_vendedor: recebe o status de cliente do tipo vendedor (padrão: sim ou nao)
considerar_cartao_credito: recebe o status de cliente do tipo cartão de crédito (padrão: sim ou nao)
checkbox_cartao_credito: recebe o status de cartão de crédito, do cliente do tipo cartão de crédito (padrão: sim ou nao)
checkbox_cartao_debito: recebe o status de cartão de débito, do cliente do tipo cartão de crédito (padrão: sim ou nao)
taxa_administradora: recebe a taxa da administradora do cliente do tipo cartão de crédito

Formato do retorno (JSON):

{
  "status": "OK", // Status de requisição bem sucedida,
  "data": [{// Lista com os usuários retornados na pesquisa.
    "id_cliente": "", // Identificador do cliente
    "email": "", // E-mail do cliente
    "celular": "", // Celular do cliente
    "nome_cliente": "", // Nome do cliente (Razão Social)
    "cpf_cnpj": "", // CPF/CNPJ do cliente
    "inscricao_estadual": "", // Inscrição estadual do cliente
    "nome_fantasia": "", // Nome fantasia do cliente (pessoa jurídica) ou apelido (pessoa física)
    "endereco_principal": "", // Endereço do cliente
    "numero_endereco_principal": "", // Número do endereço do cliente
    "complemento_endereco_principal": "", // Complemento do endereço do cliente
    "bairro_endereco_principal": "", // Bairro do cliente
    "cidade_endereco_principal": "", // Cidade do cliente
    "estado_endereco_principal": "" // Estado do cliente
    "uf_endereco_principal": "" // UF do estado do cliente
    "cep_endereco_principal": "", // Cep do cliente
    "telefone": "", // Telefone do cliente
    "instagram": "", // Endereço do perfil no Instagram do cliente
    "facebook": "", // Endereço do perfil no Facebook do cliente
    "imagem": "", // Imagem do cliente
    "sexo": "", // Gênero do cliente
    "data_nascimento": "", // Data de nascimento do cliente
    "total_pontos": "", // Total de pontos do cliente
    "categoria": "", // Categoria do cliente
    "nome_principal_vendedor": "", // Nome principal do vendedor do cliente
    "nome_principal_atendente": "", // Nome principal do atendente do cliente
    "aceita_mkt": "", // Status de cliente que aceita receber e-mail, promoções e whatsapp (sim ou nao)
    "nome_responsavel": "", // Nome do responsável do cliente, caso ele seja pessoa jurídica
    "cpf_responsavel": "", // CPF do responsável do cliente, caso ele seja pessoa jurídica
    "ativo": "", // Status de cliente ativo (ATIVO ou INATIVO)
    "cod_clie_original": "", // Código do cliente, que é utilziando pelo esoft (caso este seja um cliente)
    "cod_forn_original": "", // Código do fornecedor, que é utilziando pelo esoft (caso este seja um fornecedor)
    "cod_tran_original": "", // Código da transportadora, que é utilziando pelo esoft (caso este seja uma transportadora)
    "cod_vend_original": "" // Código do vendedor, que é utilziando pelo esoft (caso este seja um vendedor)
    "considerar_cliente": "" // Status de cliente do tipo cliente (S ou N)
    "considerar_transportadora": "" // Status de cliente do tipo transportadora (S ou N)
    "considerar_fornecedor": "" // Status de cliente do tipo fornecedor (S ou N)
    "considerar_vendedor": "" // Status de cliente do tipo vendedor (S ou N)
    "considerar_cartao_credito": "" // Status de cliente do tipo cartão de crédito (S ou N)
    "checkbox_cartao_credito": "" // Status de cartão de crédito, do cliente do tipo cartão de crédito (0 ou 1)
    "checkbox_cartao_debito": "" // Status de cartão de débito, do cliente do tipo cartão de crédito (0 ou 1)
    "taxa_administradora": "" // taxa administrativa do cartão, do cliente do tipo cartão de crédito
  }]
}

criar

Método responsável pela criação de um cliente.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = clientes): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

email: <caracter>, E-mail do cliente, tamanho máximo = 100, (obrigatório)
celular: <caracter>, Celular do cliente, tamanho máximo = 14, (obrigatório - enviar sem máscara)
nome_cliente: <caracter>, Nome do cliente (Razão Social), tamanho máximo = 100, (obrigatório)
cpf_cnpj: <caracter>, CPF/CNPJ do cliente, tamanho máximo = 14, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar" - enviar sem máscara)
inscricao_estadual: <caracter>, Inscrição estadual do cliente, (padrão: números ou "ISENTO"), tamanho máximo = 20, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar" - enviar sem máscara)
nome_fantasia: <caracter>, Nome fantasia do cliente (pessoa física) ou apelido (pessoa jurídica), tamanho máximo = 100, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar". Pode ser apelido do cliente, se o mesmo for pessoa física)
endereco_principal: <caracter>, Endereço do cliente, tamanho máximo = 90, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar")
numero_endereco_principal: <inteiro>, Número do endereço do cliente, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar")
complemento_endereco_principal: <caracter>, Complemento do endereço do cliente, tamanho máximo = 90, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar")
bairro_endereco_principal: <caracter>, Bairro do cliente, tamanho máximo = 90, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar")
cidade_endereco_principal: <caracter>, Nome da cidade do cliente, tamanho máximo = 100, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar")
estado_endereco_principal: <caracter>, Estado(UF) do cliente, tamanho máximo = 2, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar")
cep_endereco_principal: <caracter>, Cep do endereço do cliente, tamanho máximo = 9, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar" - enviar sem máscara)
telefone: <caracter>, Telefone fixo do cliente, tamanho máximo = 14, (enviar sem máscara)
instagram: <caracter>, Endereço do perfil no Instagram do cliente
facebook: <caracter>, Endereço do perfil no Facebook do cliente
nome_principal_vendedor: <caracter>, Nome principal do vendedor, tamanho máximo = 255
nome_principal_atendente: <caracter>, Nome principal do atendente, tamanho máximo = 255
categoria: <inteiro>, Categoria do cliente, default = 0
total_pontos: <decimal>, Total dos pontos do cliente, default = 0
imagem: <caracter>, Imagem convertida em base64 do cliente
sexo: <caracter>, Gênero do cliente, tamanho máximo = 1
data_nascimento: <caracter>, Data de nascimento do cliente, tamanho máximo = 10, (utilizar o padrão DD/MM/AAAA)
aceita_mkt: <inteiro>, Status de cliente que aceita receber e-mail, promoções e whatsapp (padrão: 0 ou 1), (default = 0)
nome_responsavel: <caracter>, Nome do responsável do cliente, caso ele seja pessoa jurídica, tamanho máximo = 100
cpf_responsavel: <caracter>, CPF do responsável do cliente, caso ele seja pessoa jurídica, tamanho máximo = 14
cod_clie_original: <caracter>, Código do produto, que é utilziando pelo esoft (caso este seja um cliente), tamanho máximo = 15
cod_forn_original: <caracter>, Código do produto, que é utilziando pelo esoft (caso este seja um fornecedor), tamanho máximo = 15
cod_tran_original: <caracter>, Código do produto, que é utilziando pelo esoft (caso este seja uma transportadora), tamanho máximo = 15
cod_vend_original: <caracter>, Código do produto, que é utilziando pelo esoft (caso este seja um vendedor), tamanho máximo = 15
ativo: <inteiro>, Status de cliente ativo, (obrigatório - 0 ou 1), (default = 1)
considerar_cliente: <caracter>, Status de cliente do tipo cliente (padrão: S ou N)
considerar_transportadora: <caracter>, Status de cliente do tipo transportadora (padrão: S ou N)
considerar_fornecedor: <caracter>, Status de cliente do tipo fornecedor (padrão: S ou N)
considerar_vendedor: <caracter>, Status de cliente do tipo vendedor (padrão: S ou N)
considerar_cartao_credito: <caracter>, Status de cliente do tipo cartão de crédito (padrão: S ou N)
checkbox_cartao_credito: <caracter>, Status de cartão de crédito, do cliente do tipo cartão de crédito (padrão: S ou N)
checkbox_cartao_debito: <caracter>, Status de cartão de débito, do cliente do tipo cartão de crédito (padrão: S ou N)
taxa_administradora: <decimal>, Taxa administrativa do cartão, do cliente do tipo cartão de crédito

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Cliente criado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar o cliente. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de um usuário já cadastrado.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = usuarios): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_cliente: <inteiro> identificador do cliente a ser editado, não pode ser alterado, (obrigatório)
email: <caracter>, E-mail do cliente, tamanho máximo = 100, (obrigatório)
celular: <caracter>, Celular do cliente, tamanho máximo = 14, (obrigatório - enviar sem máscara)
nome_cliente: <caracter>, Nome do cliente (Razão Social), tamanho máximo = 100, (obrigatório)
cpf_cnpj: <caracter>, CPF/CNPJ do cliente, tamanho máximo = 14, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar" - enviar sem máscara)
inscricao_estadual: <caracter>, Inscrição estadual do cliente, (padrão: números ou "ISENTO"), tamanho máximo = 20, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar" - enviar sem máscara)
nome_fantasia: <caracter>, Nome fantasia do cliente (pessoa física) ou apelido (pessoa jurídica), tamanho máximo = 100, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar". Pode ser apelido do cliente, se o mesmo for pessoa física)
endereco_principal: <caracter>, Endereço do cliente, tamanho máximo = 90, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar")
numero_endereco_principal: <inteiro>, Número do endereço do cliente, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar")
complemento_endereco_principal: <caracter>, Complemento do endereço do cliente, tamanho máximo = 90, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar")
bairro_endereco_principal: <caracter>, Bairro do cliente, tamanho máximo = 90, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar")
cidade_endereco_principal: <caracter>, Nome da cidade do cliente, tamanho máximo = 100, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar")
estado_endereco_principal: <caracter>, Estado(UF) do cliente, tamanho máximo = 2, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar")
cep_endereco_principal: <caracter>, Cep do endereço do cliente, tamanho máximo = 9, (obrigatório para os casos de envio de pedidos e nas opções de "quero me cadastrar" - enviar sem máscara)
telefone: <caracter>, Telefone fixo do cliente, tamanho máximo = 14, (enviar sem máscara)
instagram: <caracter>, Endereço do perfil no Instagram do cliente
facebook: <caracter>, Endereço do perfil no Facebook do cliente
nome_principal_vendedor: <caracter>, Nome principal do vendedor, tamanho máximo = 255
nome_principal_atendente: <caracter>, Nome principal do atendente, tamanho máximo = 255
categoria: <inteiro>, Categoria do cliente, default = 0
total_pontos: <decimal>, Total dos pontos do cliente, default = 0
imagem: <caracter>, Imagem convertida em base64 do cliente (para excluir a imagem, basta informar "remover", no campo imagem)
sexo: <caracter>, Gênero do cliente, tamanho máximo = 1
data_nascimento: <caracter>, Data de nascimento do cliente, tamanho máximo = 10, (utilizar o padrão DD/MM/AAAA)
aceita_mkt: <inteiro>, status de cliente que aceita receber e-mail, promoções e whatsapp (padrão: 0 ou 1), (default = 0)
nome_responsavel: <caracter>, Nome do responsável do cliente, caso ele seja pessoa jurídica, tamanho máximo = 100
cpf_responsavel: <caracter>, CPF do responsável do cliente, caso ele seja pessoa jurídica, tamanho máximo = 14
cod_clie_original: <caracter>, Código do produto, que é utilziando pelo esoft (caso este seja um cliente), tamanho máximo = 15
cod_forn_original: <caracter>, Código do produto, que é utilziando pelo esoft (caso este seja um fornecedor), tamanho máximo = 15
cod_tran_original: <caracter>, Código do produto, que é utilziando pelo esoft (caso este seja uma transportadora), tamanho máximo = 15
cod_vend_original: <caracter>, Código do produto, que é utilziando pelo esoft (caso este seja um vendedor), tamanho máximo = 15
ativo: <inteiro>, Status de cliente ativo, (obrigatório - 0 ou 1), (default = 1)
considerar_cliente: <caracter>, Status de cliente do tipo cliente (padrão: S ou N)
considerar_transportadora: <caracter>, Status de cliente do tipo transportadora (padrão: S ou N)
considerar_fornecedor: <caracter>, Status de cliente do tipo fornecedor (padrão: S ou N)
considerar_vendedor: <caracter>, Status de cliente do tipo vendedor (padrão: S ou N)
considerar_cartao_credito: <caracter>, Status de cliente do tipo cartão de crédito (padrão: S ou N)
checkbox_cartao_credito: <caracter>, Status de cartão de crédito, do cliente do tipo cartão de crédito (padrão: S ou N)
checkbox_cartao_debito: <caracter>, Status de cartão de débito, do cliente do tipo cartão de crédito (padrão: S ou N)
taxa_administradora: <decimal>, Taxa administrativa do cartão, do cliente do tipo cartão de crédito

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Cliente alterado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar o cliente. Verifique os campos"
}

ativar/inativar

Método responsável por ativar/inativar um cliente.

URL:

DELETE http://erp.addmob.com.br/api/inativar

Parâmetros:

url (valor = clientes): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros obrigatórios (estes parâmetros são obrigatórios - formato [campo1=v1,campo2=v2]):

id_cliente: recebe o identificador do cliente
tipo: recebe a operação (ativar ou inativar)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Cliente ativado/inativado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao ativar/inativar o cliente"
}

Módulo Checklist De Veiculo

Contém os métodos de manipulação de checklist de veiculos do sistema PortalERP.

Método(s)

listar

lista todas as checklists de veiculos cadastrados.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Observação: Para listar apenas as checklists de veiculos ativas, é obrigatório utilizar o parâmetro ativo igual a "sim" (ex: parametros=[ativo=sim])

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = checklist_veiculo ): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

id_item: recebe o identificador da checklist de veiculo
nome_item: recebe o nome da checklist de veiculo
posicao: recebe a posição da checklist de veiculo
ativo: recebe o status de checklist de veiculo ativa (padrão: sim ou nao)

Formato do retorno (JSON):

{
  "status": "OK", // Status de requisição bem sucedida,
  "data": [{// Lista com as checklists de veiculos retornadas na pesquisa.
    "nome_item": "", // Nome da checklist de veiculo
    "id_item": "", // Identificador da checklist de veiculo
    "posicao": "", // Posição da checklist de veiculo
    "ativo": "", // Status de checklist de veiculo ativa (ATIVO ou INATIVO)
  }]
}

criar

Método responsável pela criação de uma checklist de veiculo.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = checklist_veiculo ): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

nome_item: <caracter>, Nome da checklist de veiculo, tamanho máximo = 255, (obrigatório)
posicao: <inteiro>, Posição da checklist de veiculo, tamanho máximo = 3, (obrigatório)
ativo: <inteiro>, Status de checklist de veiculo ativa, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Item criado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar o Item. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de uma checklist de veiculo já cadastrada.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = checklist_veiculo ): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_item: <inteiro> identificador da checklist de veiculo a ser editada (obrigatório)
nome_item: <caracter>, Nome da checklist de veiculo, tamanho máximo = 255, (obrigatório)
posicao: <inteiro>, Posição da checklist de veiculo, tamanho máximo = 3, (obrigatório)
ativo: <inteiro>, Status de checklist de veiculo ativa, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Item alterado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar o Item. Verifique os campos"
}

ativar/inativar

Método responsável por ativar/inativar uma checklist de veiculo.

URL:

DELETE http://erp.addmob.com.br/api/inativar

Parâmetros:

url (valor = checklist_veiculo ): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros obrigatórios (estes parâmetros são obrigatórios - formato [campo1=v1,campo2=v2]):

id_item: recebe o identificador da checklist de veiculo
tipo: recebe a operação (ativar ou inativar)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "item ativado/inativado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao ativar/inativar o Item"
}

Módulo Comentário

Contém os métodos de manipulação de um comentário (de produtos e de pedidos) do sistema PortalERP.

Método(s)

listar

lista todos os comentários cadastrados.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Observação: Para listar os comentários de um produto, basta informar o id do produto no campo id_produto. Para listar os comentários de um pedido, basta informar o código do pedido no campo cod_pedido.

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = comentarios): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

id_comentario: recebe o identificador do comentário
nome_usuario: recebe o nome do usuário que fez o comentário
num_estrelas: recebe o número de estrelas do comentário
comentario: recebe o comentário
data_comentario: recebe a data e hora do comentário, no formato DD/MM/AAAA HH:MM
id_cliente: recebe o identificador do cliente ligado ao usuário que fez o comentário
id_produto: recebe o identificador do produto (este campo só será preenchido se o comentário for relacionado a um produto)
cod_pedido: recebe o código do pedido (este campo só será preenchido se o comentário for relacionado a um pedido)
ativo: recebe o status de comentário ativo (padrão: sim ou nao)

Formato do retorno (JSON):

{
  "status": "OK", // Status de requisição bem sucedida,
  "data": [{// Lista com os comentários retornados na pesquisa.
    "id_comentario": "", // Identificador do comentário
    "nome_usuario": "", // Nome do usuário que fez o comentário
    "num_estrelas": "", // Número de estrelas do comentário
    "comentario": "", // Comentário
    "data_comentario": "", // Data e hora do comentário, no formato DD/MM/AAAA HH:MM
    "id_cliente": "", // Identificador do cliente ligado ao usuário que fez o comentário
    "id_produto": "", // Identificador do produto (este campo só será preenchido se o comentário for relacionado a um produto)
    "cod_pedido": "", // Código do pedido (este campo só será preenchido se o comentário for relacionado a um pedido)
    "ativo": "", // Status de comentário ativo (ATIVO ou INATIVO)
  }]
}

criar

Método responsável pela criação de um comentário.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = comentarios): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

nome_usuario: <caracter>, Nome do usuário que fez o comentário, tamanho máximo = 255, (obrigatório, podendo ser vazio)
num_estrelas: <inteiro>, Número de estrelas do comentário
comentario: <caracter>, Texto do comentário, (obrigatório, podendo ser vazio)
data_comentario: <caracter>, Data e hora do comentário, tamanho máximo = 16, (utilizar o padrão DD/MM/AAAA HH:MM)
id_cliente: <inteiro>, Identificador do comentário ligado ao usuário que fez o comentário, (obrigatório)
id_produto: <inteiro>, Identificador do produto (obrigatório, se o comentário for relacionado a um produto)
cod_pedido: <inteiro>, Código do pedido (obrigatório, se o comentário for relacionado a um pedido)
ativo: <inteiro>, Status de comentário ativo, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Comentario criado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar o comentario. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de um comentário já cadastrado.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = comentarios): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_comentario: <inteiro> identificador do comentário a ser editado, não pode ser alterado, (obrigatório)
nome_usuario: <caracter>, Nome do usuário que fez o comentário, tamanho máximo = 255, (obrigatório, podendo ser vazio)
num_estrelas: <inteiro>, Número de estrelas do comentário
comentario: <caracter>, Texto do comentário, (obrigatório, podendo ser vazio)
data_comentario: <caracter>, Data e hora do comentário, tamanho máximo = 16, (utilizar o padrão DD/MM/AAAA HH:MM)
id_cliente: <inteiro>, Identificador do comentário ligado ao usuário que fez o comentário, (obrigatório)
id_produto: <inteiro>, Identificador do produto (obrigatório, se o comentário for relacionado a um produto)
cod_pedido: <inteiro>, Código do pedido (obrigatório, se o comentário for relacionado a um pedido)
ativo: <inteiro>, Status de comentário ativo, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Comentario alterado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar o comentario. Verifique os campos"
}

ativar/inativar

Método responsável por ativar/inativar um comentário.

URL:

DELETE http://erp.addmob.com.br/api/inativar

Parâmetros:

url (valor = comentarios): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros obrigatórios (estes parâmetros são obrigatórios - formato [campo1=v1,campo2=v2]):

id_comentario: recebe o identificador do comentário
tipo: recebe a operação (ativar ou inativar)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Comentario ativado/inativado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao ativar/inativar o comentario"
}

Módulo Empresa

Contém os métodos de manipulação de uma empresa do sistema PortalERP.

Método(s)

listar

lista os dados da empresa ligada ao usuário que está consumindo esta API.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = empresa): recebe o nome do módulo a ser utilizado;
parametros: Deve ser passado um array vazio (exemplo: parametros=[]).

Formato do retorno (JSON):

{
  "status": "OK" // Status de requisição bem sucedida,
  "data": { // Objeto com os dados da empresa.
    "codregistro": "", // Código de registro da empresa
    "nome_empresa": "", // Nome da empresa (nome fantasia)
    "razaosocial": "", // Razão social da empresa
    "cnpj": "", // CNPJ da empresa
    "telefone": "", // Telefone da empresa
    "email": "", // Endereço do e-mail da empresa
    "site": "", // Web site da empresa
    "endereco": "", // Endereço da empresa
    "numeroendereco": "", // Número do endereço da empresa
    "complemento": "", // Complemento do endereço da empresa
    "bairro": "", // Bairro da empresa
    "cidade": "", // Cidade da empresa
    "estado": "", // Estado empresa
    "uf": "", // UF da empresa
    "cep": "", // Cep da empresa
    "termos_uso": "", // Termos de uso da empresa
    "logoempresa": "", // Imagem da empresa
    "imagem_menu": "", // Imagem a ser utilizada no menu principal do aplicativo cardapioshow (somente para empresas cadastradas no módulo cardápioshow)
    "facebook": "", // Endereço do perfil da empresa no Facebook
    "instagram": "", // Endereço do perfil da empresa no Instagram
    "twitter": "", // Endereço do perfil da empresa no Twitter
    "usu_integrador_cartao_app": "", // Usuário de integração com API de pagamento (Para aplicativos). Este campo é retornado criptografado
    "senha_integrador_cartao_app": "", // Senha de integração com API de pagamento (Para aplicativos). Este campo é retornado criptografado
    "token_integrador_cartao_app": "", // Token de integração com API de pagamento (Para aplicativos). Este campo é retornado criptografado
    "usu_integrador_transp": "", // Usuário de integração com API de transportadora. Este campo é retornado criptografado
    "senha_integrador_transp": "", // Senha de integração com API de transportadora. Este campo é retornado criptografado
    "token_integrador_transp": "", // Token de integração com API de transportadora. Este campo é retornado criptografado
    "usu_integrador_cartao_loja_virtual": "", // Usuário de integração com API de pagamento (Para loja vitual). Este campo é retornado criptografado
    "senha_integrador_cartao_loja_virtual": "", // Senha de integração com API de pagamento (Para loja vitual). Este campo é retornado criptografado
    "token_integrador_cartao_loja_virtual": "", // Token de integração com API de pagamento (Para loja vitual). Este campo é retornado criptografado
  }
}

editar

Método responsável pela alteração dos dados da empresa ligada ao usuário que está consumindo esta API.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = empresa): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

nome_empresa: <caracter>, Nome da empresa (nome fantasia), tamanho máximo = 300, (obrigatório)
razaosocial: <caracter>, Razão social da empresa, tamanho máximo = 300, (obrigatório)
telefone: <caracter>, Telefone da empresa, tamanho máximo = 16, (enviar sem máscara)
emai: <caracter>, Endereço de e-mail da empresa, tamanho máximo = 50
site: <caracter>, Web site da empresa, tamanho máximo = 50
endereco: <caracter>, Endereço da empresa, tamanho máximo = 90, (obrigatório)
numeroendereco: <inteiro>, Número do endereço da empresa, (obrigatório)
complemento: <caracter>, Complemento do endereço da empresa, tamanho máximo = 90
bairro: <caracter>, Bairro da empresa, tamanho máximo = 90, (obrigatório)
cidade: <caracter>, Nome da cidade da empresa, tamanho máximo = 100, (obrigatório)
estado: <caracter>, Estado(UF) da empresa, tamanho máximo = 2, (obrigatório)
cep: <caracter>, Cep do endereço da empresa, tamanho máximo = 9, (obrigatório - enviar sem máscara)
termos_uso: <caracter>, Termos de uso da empresa
logo_empresa: <caracter>, Imagem convertida em base64 da empresa
imagem_menu: <caracter>, Imagem convertida em base64 a ser utilizada no menu principal do aplicativo cardapioshow (somente para empresas cadastradas no módulo cardápioshow)
facebook: <caracter>, Endereço do perfil da empresa no Facebook
instagram: <caracter>, Endereço do perfil da empresa no Instagram
twitter: <caracter>, Endereço do perfil da empresa no Twitter
usu_integrador_cartao_app: <caracter>, Usuário de integração com API de pagamento (Para aplicativos). Este campo precisa ser enviado criptografado
senha_integrador_cartao_app: <caracter>, Senha de integração com API de pagamento (Para aplicativos). Este campo precisa ser enviado criptografado
token_integrador_cartao_app: <caracter>, Token de integração com API de pagamento (Para aplicativos). Este campo precisa ser enviado criptografado
usu_integrador_transp: <caracter>, Usuário de integração com API de transportadora. Este campo precisa ser enviado criptografado
senha_integrador_transp: <caracter>, Senha de integração com API de transportadora. Este campo precisa ser enviado criptografado
token_integrador_transp: <caracter>, Token de integração com API de transportadora. Este campo precisa ser enviado criptografado
usu_integrador_cartao_loja_virtual: <caracter>, Usuário de integração com API de pagamento (Para loja vitual). Este campo precisa ser enviado criptografado
senha_integrador_cartao_loja_virtual: <caracter>, Senha de integração com API de pagamento (Para loja vitual). Este campo precisa ser enviado criptografado
token_integrador_cartao_loja_virtual: <caracter>, Token de integração com API de pagamento (Para loja vitual). Este campo precisa ser enviado criptografado

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Empresa alterada com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar a empresa. Verifique os campos"
}

Módulo Forma de Entrega

Contém os métodos de manipulação de uma forma de entrega do sistema PortalERP.

Método(s)

listar

lista todas as formas de entrega cadastradas.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Observação: Para listar apenas as formas de entrega ativas, é obrigatório utilizar o parâmetro ativo igual a "sim" (ex: parametros=[ativo=sim])

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = formas_entrega): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

id_forma_entrega: recebe o identificador da forma de entrega
nome_forma_entrega: recebe o nome da forma de entrega
ativo: recebe o status de forma de entrega ativo (padrão: sim ou nao)
enviaapp: recebe o status de forma de entrega que é enviada para o aplicativo (padrão: 1 ou 0)
envialoja: recebe o status de forma de entrega que é enviada para a loja virtual (padrão: 1 ou 0)

Formato do retorno (JSON):

{
  "status": "OK" // Status de requisição bem sucedida,
  "data": [{ // Lista com as formas de pagamento retornadas na pesquisa.
    "id_forma_entrega": "", // Identificador da forma de entrega
    "nome_forma_entrega": "", // Nome da forma de entrega
    "enviaapp": "", // Status de forma de entrega que é enviada para o aplicativo (1 ou 0)
    "envialoja": "", // Status de forma de entrega que é enviada para a loja virtual (1 ou 0)
    "ativo": "" // Status de forma de entrega ativa (ATIVO ou INATIVO)
  }]
}

criar

Método responsável pela criação de uma forma de entrega.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = formas_entrega): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

nome_forma_entrega: <caracter>, nome da forma de entrega, tamanho máximo = 100 (obrigatório)
enviaapp: <inteiro>, status de forma de entrega que é enviada para o aplicativo, (0 ou 1), (default = 0)
envialoja: <inteiro>, status de forma de entrega que é enviada para a loja virtual, (0 ou 1), (default = 0)
ativo: <inteiro>, Status de forma de entrega ativa, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Forma de entrega criada com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar a forma de entrega. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de uma forma de entrega já cadastrada.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = formas_entrega): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_forma_entrega: <inteiro>, identificador da forma de entrega a ser editada, não pode ser alterado, (obrigatório)
nome_forma_entrega: <caracter>, nome da forma de entrega, tamanho máximo = 100 (obrigatório)
enviaapp: <inteiro>, status de forma de entrega que é enviada para o aplicativo, (0 ou 1), (default = 0)
envialoja: <inteiro>, status de forma de entrega que é enviada para a loja virtual, (0 ou 1), (default = 0)
ativo: <inteiro>, Status de forma de entrega ativa, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Forma de entrega alterado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar a forma de entrega. Verifique os campos"
}

ativar/inativar

Método responsável por ativar/inativar uma forma de entrega.

URL:

DELETE http://erp.addmob.com.br/api/inativar

Parâmetros:

url (valor = formas_entrega): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros obrigatórios (estes parâmetros são obrigatórios - formato [campo1=v1,campo2=v2]):

id_forma_entrega: recebe o identificador da forma de entrega
tipo: recebe a operação (ativar ou inativar)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Forma de entrega ativado/inativado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao ativar/inativar a forma de entrega de produtos"
}

Módulo Forma de Pagamento

Contém os métodos de manipulação de uma forma de pagamento do sistema PortalERP.

Método(s)

listar

lista todas as formas de pagamento cadastradas.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Observação: Para listar apenas as formas de pagamento ativas, é obrigatório utilizar o parâmetro ativo igual a "sim" (ex: parametros=[ativo=sim])

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = formas_pagamento): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

id_forma_pagamento: recebe o identificador da forma de pagamento
nome_forma_pagamento: recebe o nome da forma de pagamento
ativo: recebe o status de forma de pagamento ativo (padrão: sim ou nao)
enviaapp: recebe o status de forma de pagamento que é enviada para o aplicativo (padrão: 1 ou 0)
envialoja: recebe o status de forma de pagamento que é enviada para a loja virtual (padrão: 1 ou 0)

Formato do retorno (JSON):

{
  "status": "OK" // Status de requisição bem sucedida,
  "data": [{ // Lista com as formas de pagamento retornadas na pesquisa.
    "id_forma_pagamento": "", // Identificador da forma de pagamento
    "nome_forma_pagamento": "", // Nome da forma de pagamento
    "enviaapp": "", // Status de forma de pagamento que é enviada para o aplicativo (SIM ou NAO)
    "envialoja": "", // Status de forma de pagamento que é enviada para a loja virtual (SIM ou NAO)
    "ativo": "" // Status de forma de pagamento pagamento ativa (ATIVO ou INATIVO)
  }]
}

criar

Método responsável pela criação de uma forma de pagamento.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = formas_pagamento): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

nome_forma_pagamento: <caracter>, nome da forma de pagamento, tamanho máximo = 100 (obrigatório)
enviaapp: <inteiro>, status de forma de pagamento que é enviada para o aplicativo, (0 ou 1), (default = 0)
envialoja: <inteiro>, status de forma de pagamento que é enviada para a loja virtual, (0 ou 1), (default = 0)
ativo: <inteiro>, Status de forma de pagamento ativa, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Forma de pagamento criada com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar a forma de pagamento. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de uma forma de pagamento já cadastrada.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = formas_pagamento): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_forma_pagamento: <inteiro>, identificador da forma de pagamento a ser editada, não pode ser alterado, (obrigatório)
nome_forma_pagamento: <caracter>, nome da forma de pagamento, tamanho máximo = 100 (obrigatório)
enviaapp: <inteiro>, status de forma de pagamento que é enviada para o aplicativo, (0 ou 1), (default = 0)
envialoja: <inteiro>, status de forma de pagamento que é enviada para a loja virtual, (0 ou 1), (default = 0)
ativo: <inteiro>, Status de forma de pagamento ativa, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Forma de pagamento alterado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar a forma de pagamento. Verifique os campos"
}

ativar/inativar

Método responsável por ativar/inativar uma forma de pagamento.

URL:

DELETE http://erp.addmob.com.br/api/inativar

Parâmetros:

url (valor = formas_pagamento): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros obrigatórios (estes parâmetros são obrigatórios - formato [campo1=v1,campo2=v2]):

id_forma_pagamento: recebe o identificador da forma de pagamento
tipo: recebe a operação (ativar ou inativar)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Forma de pagamento ativado/inativado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao ativar/inativar a forma de pagamento"
}

Módulo Geolocalização

Contém os métodos de utilização da API para manipulação da Geolocalização.

Método(s)

calcular_distancia

Calcula a distância entre dois pontos informados através de coordenadas geograficas informadas.

URL:

POST http://erp.addmob.com.br/api/calcular_distancia

Parâmetros do corpo da requisição POST:

origem: <caracter>, recebe a latitude e longitude do ponto de origem separados por virgula(,).
destino: <caracter>, recebe a latitude e longitude do ponto de destino separados por virgula(,).

Formato do retorno (JSON):

{
"mensagem": "3115.1 km", // Distância em km,
"status": "OK" // Status de requisição bem sucedida,
}

obter_coordenadas

Localiza o endereço informado e converte em coordenadas geográficas(latitude, longitude).

URL:

POST http://erp.addmob.com.br/api/obter_coordenadas

Parâmetros do corpo da requisição POST:

estado: <caracter>, recebe o nome do estado, pode ser a silga ou nome completo. (obrigatório)
cidade: <caracter>, recebe o nome da cidade. (obrigatório)
bairro: <caracter>, recebe o nome do bairro.
rua: <caracter>, recebe o nome da rua. (obrigatório)
numero: <caracter>, recebe o número de endereço da rua. (obrigatório)

Formato do retorno (JSON):

{
"mensagem": "-19.9211154,-43.9414792", // Latitude, longitude
"status": "OK" // Status de requisição bem sucedida,
}

Módulo Grupos de Produtos

Contém os métodos de manipulação de um grupo de produtos do sistema PortalERP.

Método(s)

listar

lista todos os grupos de produtos cadastrados.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Observação: Para listar apenas os grupos de produtos ativos, é obrigatório utilizar o parâmetro ativo igual a "sim" (ex: parametros=[ativo=sim])

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = grupos): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

id_grupo: recebe o identificador do grupo de produtos
nome_grupo: recebe o nome do grupo de produtos
ativo: recebe o status de grupo de produtos ativo (padrão: sim ou nao)
possui_subgrupo: recebe o status de grupo de produtos que possui subgrupo (padrão: sim ou nao)
id_pai: recebe o identificador do pai do grupo de produtos
id_aplicativo: recebe o identificador do aplicativo na qual este grupo de produtos está ligado(0 = ERP, 1 = Loja, 2 = App)
cod_grupo_original: recebe o código do grupo de produtos, que é utilziando pelo esoft
cod_subgrupo_original: recebe o código do subgrupo de produtos, que é utilziando pelo esoft

Formato do retorno (JSON):

{
  "status": "OK" // Status de requisição bem sucedida,
  "data": [{ // Lista com os grupos de produtos retornados na pesquisa.
    "id_grupo": "", // Identificador do grupo de produtos
    "id_pai": "", // Identificador do grupo pai deste grupo de produtos
    "imagem": "", // localização (URL) da imagem deste grupo de produtos
    "nome_grupo": "", // Nome do grupo de produtos
    "possui_subgrupo": "", // Status (S ou N) de grupo de produtos que possui filhos(sub grupos)
    "path": "", // String contendo a estrutura hierárquica dos pais deste grupo de produtos, caso existam (ex: 0/1/3/5)
    "ativo": "" // Status de grupo de produtos ativo (ATIVO ou INATIVO)
    "cod_grupo_original": "" // Código do grupo de produtos, que é utilziando pelo esoft
    "cod_subgrupo_original": "" // Código do subgrupo de produtos, que é utilziando pelo esoft
  }]
}

criar

Método responsável pela criação de um grupo de produtos.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = grupos): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_pai: <inteiro>, Identificador do grupo de produtos, (obrigatório - default = 0)
nome_grupo: <caracter>, Nome do grupo de produtos, tamanho máximo = 100 (obrigatório)
logo_grupo: <caracter>, Imagem convertida em base64 do grupo de produtos
posicao: <caracter>, Posição do grupo de produtos a ser exibida na listagem de grupos, (obrigatório - default = 999)
ativo: <inteiro>, Status de grupo de produtos ativo, (obrigatório - 0 ou 1), (default = 1)
id_aplicativo: <inteiro>, Identificador do aplicativo na qual este grupo de produtos será exibido (padrão: 0 = ERP, 1 = Loja, 2 = App)
cod_grupo_original: <caracter>, código do grupo de produtos, que é utilziando pelo esoft, tamanho máximo = 3
cod_subgrupo_original: <caracter>, código do subgrupo de produtos, que é utilziando pelo esoft, tamanho máximo = 3

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Grupo de produtos criado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar o grupo de produtos. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de um grupo de produtos já cadastrado.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = grupos): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_grupo: <inteiro>, identificador do grupo de produtos a ser editado, não pode ser alterado, (obrigatório)
id_pai: <inteiro>, Identificador do grupo de produtos, (obrigatório - default = 0)
nome_grupo: <caracter>, nome do grupo de produtos, tamanho máximo = 100 (obrigatório)
logo_grupo: <caracter>, imagem convertida em base64 do grupo de produtos (para excluir a imagem, basta informar "remover", no campo logo_grupo)
posicao: <caracter>, Posição do grupo de produtos a ser exibida na listagem de grupos, (obrigatório - default = 999)
ativo: <inteiro>, Status de grupo de produtos ativo, (obrigatório - 0 ou 1), (default = 1)
id_aplicativo: <inteiro>, Identificador do aplicativo na qual este grupo de produtos será exibido (padrão: 0 = ERP, 1 = Loja, 2 = App)
cod_grupo_original: <caracter>, código do grupo de produtos, que é utilziando pelo esoft, tamanho máximo = 3
cod_subgrupo_original: <caracter>, código do subgrupo de produtos, que é utilziando pelo esoft, tamanho máximo = 3

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Grupo de produtos alterado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar o grupo de produtos. Verifique os campos"
}

ativar/inativar

Método responsável por ativar/inativar um grupo de produtos.

URL:

DELETE http://erp.addmob.com.br/api/inativar

Parâmetros:

url (valor = grupos): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros obrigatórios (estes parâmetros são obrigatórios - formato [campo1=v1,campo2=v2]):

id_grupo: recebe o identificador do grupo de produtos
tipo: recebe a operação (ativar ou inativar)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Grupo de produtos ativado/inativado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao ativar/inativar o grupo de produtos"
}

Módulo Marca

Contém os métodos de manipulação de marcas do sistema PortalERP.

Método(s)

listar

lista todas as marcas cadastradas.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Observação: Para listar apenas as marcas ativas, é obrigatório utilizar o parâmetro ativo igual a "sim" (ex: parametros=[ativo=sim])

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = marcas ): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

id_marca: recebe o identificador da marca
nome_marca: recebe o nome da marca
cod_marca_original: recebe o código original da marca
ativo: recebe o status de marca ativa (padrão: sim ou nao)

Formato do retorno (JSON):

{
  "status": "OK", // Status de requisição bem sucedida,
  "data": [{// Lista com as marcas retornadas na pesquisa.
    "id_marca": "", // Identificador da marca
    "nome_marca": "", // Nome da marca
    "cod_marca_original": "", // Código original da marca
    "ativo": "", // Status de marca ativa (ATIVO ou INATIVO)
  }]
}

criar

Método responsável pela criação de uma marca.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = marcas ): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

nome_marca: <caracter>, Nome da marca, tamanho máximo = 50, (obrigatório)
cod_marca_original: <caracter>, Código original da marca, tamanho máximo = 3, (obrigatório)
ativo: <inteiro>, Status de marca ativa, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Marca criada com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar a Marca. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de uma marca já cadastrada.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = marcas ): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_marca: <inteiro> identificador da marca a ser editada (obrigatório)
nome_marca: <caracter>, Nome da marca, tamanho máximo = 50, (obrigatório)
cod_marca_original: <caracter>, Código original da marca, tamanho máximo = 3, (obrigatório)
ativo: <inteiro>, Status de marca ativa, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Marca alterada com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar a Marca. Verifique os campos"
}

ativar/inativar

Método responsável por ativar/inativar uma marca.

URL:

DELETE http://erp.addmob.com.br/api/inativar

Parâmetros:

url (valor = marcas ): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros obrigatórios (estes parâmetros são obrigatórios - formato [campo1=v1,campo2=v2]):

id_marca: recebe o identificador da marca
tipo: recebe a operação (ativar ou inativar)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Marca ativada/inativada com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao ativar/inativar a Marca"
}

Módulo Modelos

Contém os métodos de manipulação de modelos do sistema PortalERP.

Método(s)

listar

lista todos os modelos cadastrados.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Observação: Para listar apenas os modelos ativos, é obrigatório utilizar o parâmetro ativo igual a "sim" (ex: parametros=[ativo=sim])

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = modelos ): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

id_modelo: recebe o identificador do modelo
nome_modelo: recebe o nome do modelo
id_marca: recebe o id da marca
nome_marca: recebe o nome da marca
cod_modelo_original: recebe o código original do modelo
ativo: recebe o status de modelo ativo (padrão: sim ou nao)

Formato do retorno (JSON):

{
  "status": "OK", // Status de requisição bem sucedida,
  "data": [{// Lista com as modelos retornadas na pesquisa.
    "id_modelo": "", // Identificador do modelo
    "nome_modelo": "", // Nome do modelo
    "id_marca": "", // Identificador da marca
    "nome_marca": "", // Nome da Marca
    "cod_modelo_original": "", // Código original do modelo
    "ativo": "", // Status de modelo ativo (ATIVO ou INATIVO)
  }]
}

criar

Método responsável pela criação de um modelo.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = modelos ): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

nome_modelo: <caracter>, Nome do modelo, tamanho máximo = 50, (obrigatório)
id_marca: <caracter>, Identificador da marca, tamanho máximo = 11, (obrigatório)
nome_marca: <caracter>, Nome da marca, tamanho máximo = 50, (obrigatório)
cod_modelo_original: <caracter>, Código do modelo original, tamanho máximo = 3, (obrigatório)
ativo: <inteiro>, Status de modelo ativo, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Modelo criado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar o modelo. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de um modelo já cadastrada.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = modelos ): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_modelo: <inteiro> identificador do modelo a ser editado (obrigatório)
id_marca: <inteiro>, Identificador da marca, tamanho máximo = 11, (obrigatório)
nome_modelo: <caracter>, Nome do modelo, tamanho máximo = 50, (obrigatório)
nome_marca: <caracter>, Nome da marca, tamanho máximo = 50, (obrigatório)
cod_modelo_original: <caracter>, Código do modelo original, tamanho máximo = 3, (obrigatório)
ativo: <inteiro>, Status de modelo ativo, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Modelo alterado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar o Modelo. Verifique os campos"
}

ativar/inativar

Método responsável por ativar/inativar um modelo.

URL:

DELETE http://erp.addmob.com.br/api/inativar

Parâmetros:

url (valor = modelos ): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros obrigatórios (estes parâmetros são obrigatórios - formato [campo1=v1,campo2=v2]):

id_modelo: recebe o identificador do modelo
tipo: recebe a operação (ativar ou inativar)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Modelo ativado/inativado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao ativar/inativar o Modelo"
}

Módulo Parceiro

Contém os métodos de manipulação de um parceiro do sistema PortalERP.

Método(s)

listar

lista todos os parceiros cadastrados.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Observação: Para listar apenas os parceiros ativos, é obrigatório utilizar o parâmetro ativo igual a "sim" (ex: parametros=[ativo=sim])

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = parceiros): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

ativo: recebe o status de parceiro ativo (padrão: sim ou nao)
bairro_endereco_principal: recebe o bairro do parceiro
celular: recebe o número do celular do parceiro
cep_endereco_principal: recebe o cep do paceiro
cidade_endereco_principal: recebe a cidade do parceiro
complemento_endereco_principal: recebe o complemento do endereço do parceiro
cpf_cnpj: recebe o CPF/CNPJ do parceiro
email: recebe o e-mail do parceiro
endereco_principal: recebe o endereço do parceiro
estado_endereco_principal: recebe o nome do estado do parceiro
id_parceiro: recebe o identificador do parceiro
imagem: recebe a foto do parceiro
nome_parceiro: recebe o nome do parceiro
numero_endereco_principal: recebe o número do endereço do parceiro
ponto_referencia: recebe o ponto de referencia do endereco do parceiro
site: recebe o site do parceiro
telefone: recebe o telefone fixo do parceiro

Formato do retorno (JSON):

{
  "status": "OK" // Status de requisição bem sucedida,
  "data": [{ // Lista com os parceiros retornados na pesquisa.
    "ativo": "", // Status de parceiro ativo (ATIVO ou INATIVO)
    "bairro_endereco_principal": "", // Bairro do parceiro
    "celular": "", // Celular do parceiro
    "cep_endereco_principal": "", // Cep do parceiro
    "cidade_endereco_principal": "", // Cidade do parceiro
    "complemento_endereco_principal": "", // Complemento do endereço do parceiro
    "cpf_cnpj": "", // CPF/CNPJ do parceiro
    "email": "", // E-mail do parceiro
    "endereco_principal": "", // Endereço do parceiro
    "estado_endereco_principal": "", // Estado do parceiro
    "id_parceiro": "", // Identificador do parceiro
    "nome_parceiro": "", // Nome do parceiro
    "numero_endereco_principal": "", // Numero do endereço do parceiro
    "ponto_referencia": "", // Ponto de referencia do endereço do parceiro
    "site": "", // Site do parceiro
    "telefone": "", // Telefone fixo do parceiro
    }],
}

criar

Método responsável pela criação de um parceiro.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = parceiros): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

ativo: <inteiro>, Status de parceiro ativo, (obrigatório - 0 ou 1), (default = 1)
bairro: <caracter>, Bairro do parceiro
celular: <caracter>, Celular do parceiro
cep_endereco_principal: <caracter>, Cep do endereço do parceiro
cidade_endereco_principal: <caracter>, Cidade do parceiro
complemento_endereco_principal: <caracter>, Complemento da endereço do parceiro
cpf_cnpj: <caracter>, CPF/CNPJ do parceiro, (obrigatório)
email: <caracter>, E-mail do parceiro, (obrigatório)
endereco_principal: <caracter>, Endereço do parceiro
estado_endereco_principal: <caracter>, Estado do parceiro
imagem: <caracter>, Imagem convertida em base64 do parceiro
nome_parceiro: <caracter>, Nome do parceiro, tamanho máximo = 255, (obrigatório)
numero_endereco_principal: <inteiro>, Numero do endereço do parceiro
ponto_referencia: <caracter>, Ponto de referencia do endereço do parceiro
site: <caracter>, Site do parceiro
telefone: <caracter>, Telefone fixo de parceiro, (obrigatório)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Parceiro criado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar o parceiro. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de um parceiro já cadastrado.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = parceiros): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

ativo: <inteiro>, Status de parceiro ativo, (obrigatório - 0 ou 1), (default = 1)
bairro: <caracter>, Bairro do parceiro
celular: <caracter>, Celular do parceiro
cep_endereco_principal: <caracter>, Cep do endereço do parceiro
cidade_endereco_principal: <caracter>, Cidade do parceiro
complemento_endereco_principal: <caracter>, Complemento da endereço do parceiro
cpf_cnpj: <caracter>, CPF/CNPJ do parceiro, (obrigatório)
email: <caracter>, E-mail do parceiro
endereco_principal: <caracter>, Endereço do parceiro
estado_endereco_principal: <caracter>, Estado do parceiro
id_parceiro: <inteiro>, Identifcador do grupo do parceiro, (obrigatório)
imagem: <caracter>, Imagem convertida em base64 do parceiro
nome_parceiro: <caracter>, Nome do parceiro, tamanho máximo = 255, (obrigatório)
numero_endereco_principal: <inteiro>, Numero do endereço do parceiro
ponto_referencia: <caracter>, Ponto de referencia do endereço do parceiro
site: <caracter>, Site do parceiro
telefone: <caracter>, Telefone fixo de parceiro, (obrigatório)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Parceiro alterado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar o parceiro. Verifique os campos"
}

ativar/inativar

Método responsável por ativar/inativar um parceiro.

URL:

DELETE http://erp.addmob.com.br/api/inativar

Parâmetros:

url (valor = parceiros): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros obrigatórios (estes parâmetros são obrigatórios - formato [campo1=v1,campo2=v2]):

id_parceiro: recebe o identificador do parceiro
tipo: recebe a operação (ativar ou inativar)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Parceiro ativado/inativado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao ativar/inativar o parceiro"
}

Módulo Produto

Contém os métodos de manipulação de um produto do sistema PortalERP.

Método(s)

listar

lista todos os produtos cadastrados.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Observação: Para listar apenas os produtos ativos, é obrigatório utilizar o parâmetro ativo igual a "sim" (ex: parametros=[ativo=sim])

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = produtos): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

id_produto: recebe o identificador do produto
codbarra: recebe o código de barras do produto
cod_fabricante: recebe o código do fabricante do produto
nome_produto_1: recebe o nome do produto
descricao_produto_1: recebe recebe a descrição do produto
unidademedida: recebe a unidade de medida do produto
lista_grupos: recebe uma lista contendo os grupos que o produto pertence
peso_bruto: recebe o peso bruto do produto
peso_liquido: recebe o peso líquido do produto
largura: recebe a largura do produto
comprimento: recebe o comprimento do produto
altura: recebe a altura do produto
preco_venda: recebe o preço de venda do produto
preco_lojista: recebe o preço do lojista do produto
estoque: recebe a quantidade em estoque do produto
ativo: recebe o status de produto ativo (padrão: sim ou nao)
prazo_producao: recebe o número de dias que levará para a produção, caso o produto tenha estoque igual a zero
promocao: recebe o status de promoção habilitada para este produto (padrão: s ou n)
cod_original: recebe o código do produto, que é utilziando pelo esoft
ultima_data_atualizacao: recebe a última data de atualização do produto (formato: DD/MM/AAAA HH:MM:SS)
preco_custo: recebe o preço de custo do produto
estoque_minimo: recebe o estoque mínimo do produto
estoque_maximo: recebe o estoque máximo do produto
margem_lucro: recebe a margem de lucro do produto
tipo_produto: recebe o tipo do produto (padrão: venda, revenda, serviço)
descontar_icms_desonerado: recebe o status de produto a descontar ICMS desonerado (padrão: sim ou nao)
id_fornecedor: recebe o identificador do fornecedor do produto
id_classificacao_fiscal: recebe a classificação fiscal do produto

Formato do retorno (JSON):

{
  "status": "OK" // Status de requisição bem sucedida,
  "data": [{ // Lista com os produtos retornados na pesquisa.
    "id_produto": "", // Identificador do produto
    "codbarra": "", // Código de barras do produto
    "cod_fabricante": "", // Código do fabricante do produto
    "nome_produto_1": "", // Nome do produto
    "descricao_produto_1": "", // Descrição do produto
    "unidademedida": "", // Unidade de medida do produto
    "lista_grupos": { // JSON contendo os grupos ligados ao produto
      "1": {, // Ordem
        "id_grupo": "123", // id do grupo 1
        "nome_grupo": "grupo 123", // nome do grupo 1
      }, "2": {// Ordem
        "id_grupo": "456", // id do grupo 2
        "nome_grupo": "grupo 456, // nome do grupo 2
      }
    },
    "peso_bruto": "", // Peso bruto do produto
    "peso_liquido": "", // Peso líquido do produto
    "largura": "", // Largura do produto
    "comprimento": "", // Comprimento do produto
    "altura": "", // Altura do produto
    "preco_venda": "", // Preço de venda do produto
    "preco_lojista": "", // Preço do lojista do produto
    "estoque": "", // Quantidade em estoque do produto
    "ativo": "", // Status de produto ativo (ATIVO ou INATIVO)
    "prazo_producao": "", // Número de dias que levará para a produção, caso o produto tenha estoque igual a zero
    "cod_original": "" // Código do produto, que é utilziando pelo esoft
    "imagem": "", // localização (URL) da imagem deste produto
    "promocao": "", // Status de promoção habilitada para este produto (S ou N)
    "ultima_data_atualizacao": "", // Última data de atualização do produto
    "preco_custo": "", // Preço de custo do produto
    "estoque_minimo": "", // Estoque mínimo do produto
    "estoque_maximo": "", // Estoque máximo do produto
    "margem_lucro": "", // Margem de lucro do produto
    "tipo_produto": "", // Tipo do produto (venda, revenda, serviço)
    "descontar_icms_desonerado": "", // Status de produto a descontar ICMS desonerado (Sim ou Nao)
    "id_fornecedor": "", // Identificador do fornecedor do produto
    "nome_fornecedor": "", // Nome do fornecedor do produto
    "id_classificacao_fiscal": "", // Classificação fiscal do produto
    "lista_promocoes": [{ // Lista de promoções ligadas a este produto
      "id_promocao": "", // Identificador da promoção
      "estoque_promocao": "", // Estoque da promoção (Se estiver = 0, o estoque é ilimitado para a promoção. Caso contrário, deverá limitar a essa quantidade e checar isso no momento de gravar a venda no app)
      "dt_usoini": "", // Data inicial da promoção
      "dt_usofim": "", // Data final da promoção
      "precopromo": "", // Preço da promoção
      "quantidade": "", // Quantidade mínima da promoção (Se igual a 0 (zero), pode comprar qualquer quantidade. Se maior que 1, sistema deverá tratar a promoção de acordo com as unidades)
      "observacao": "", // Observação da promoção
    }],
    "tributacao": { // Tributação ligada a este produto
      "ncm": "", // Número NCM do produto
      "cest": "", // Número CEST do produto
      "aliquota_icms": "", // Alíquota de ICMS do produto
      "aliquota_icmsst": "", // Alíquota de ST do produto
      "base_icms": "", // Base ICMS do produto
      "base_st": "", // Base ST do produto
      "aliquota_ipi": "", // Alíquota de IPI do produto
      "csosn": "", // CSOSN do produto
      "cod_tributario": "" // Código tributário do produto
    }
  }]
}

criar

Método responsável pela criação de um produto.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = produtos): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

codbarra: <caracter>, Código de barras do produto, tamanho máximo = 20, (obrigatório)
cod_fabricante: <caracter>, Código do fabricante do produto, tamanho máximo = 20
nome_produto_1: <caracter>, Nome do produto, tamanho máximo = 255, (obrigatório)
descricao_produto_1: <caracter>, Descrição do produto,
unidademedida: <caracter>, Unidade de medida do produto, tamanho máximo = 6, (obrigatório)
lista_grupos: <caracter>, JSON contendo os grupos ligados ao produto (default = {})
peso_bruto: <decimal>, Peso bruto do produto
peso_liquido: <decimal>, Peso líquido do produto
largura: <decimal>, Largura do produto
comprimento: <decimal>, Comprimento do produto
altura: <decimal>, Altura do produto
preco_venda: <decimal>, Preço de venda do produto, (obrigatório)
preco_lojista: <decimal>, Preço do lojista do produto
estoque: <decimal>, Quantidade em estoque do produto
ativo: <inteiro>, Status de produto ativo, (obrigatório - 0 ou 1), (default = 1)
prazo_producao: <inteiro>, Número de dias que levará para a produção, caso o produto tenha estoque igual a zero
cod_original: <caracter>, código do produto, que é utilziando pelo esoft, tamanho máximo = 15
imagem: <caracter>, Imagem convertida em base64 do produto
preco_custo: <decimal>, Preço de custo do produto
estoque_minimo: <decimal>, Estoque mínimo do produto
estoque_maximo: <decimal>, Estoque máximo do produto
margem_lucro: <decimal>, Margem de lucro do produto
tipo_produto: <caracter>, Tipo do produto, tamanho máximo = 1, (V = venda, R = revenda, S = serviço)
descontar_icms_desonerado: <inteiro>, Status de produto a descontar ICMS desonerado, (0 ou 1)
id_fornecedor: <inteiro>, Identificador do fornecedor do produto
id_classificacao_fiscal: <caracter>, Classificação fiscal do produto
promocao: <caracter>, Status de promoção habilitada para este produto, tamanho máximo = 1, (S ou N, default=N - para cadastrar uma promoção é obrigatório que este campo esteja setado com 'S')

Os campos abaixo são referentes a criação de uma promoção vinculada a este produto.
Para cada promoção, deve-se criar um grupo de campos abaixo, adicionando o índice de cada promoção, começando por 1. Ex: (estoque_promocao1, estoque_promocao2, ...).
Estes campos não são obrigatórios.
estoque_promocao<indice>: <decimal>, Estoque da promoção (Se estiver = 0, o estoque é ilimitado para a promoção. Caso contrário, deverá limitar a essa quantidade e checar isso no momento de gravar a venda no app), (obrigatório - em caso de houver promoção a ser cadastrada)
dt_usoini<indice>: <caracter>, Data inicial da promoção, tamanho máximo = 10, (utilizar o padrão DD/MM/AAAA), (obrigatório - em caso de houver promoção a ser cadastrada)
dt_usofim<indice>: <caracter>, Data final da promoção, tamanho máximo = 10, (utilizar o padrão DD/MM/AAAA), (obrigatório - em caso de houver promoção a ser cadastrada)
precopromo<indice>: <decimal>, Preço da promoção, (obrigatório - em caso de houver promoção a ser cadastrada)
quantidade<indice>: <decimal>, Quantidade mínima da promoção (Se igual a 0 (zero), pode comprar qualquer quantidade. Se maior que 1, sistema deverá tratar a promoção de acordo com as unidades), (obrigatório - em caso de houver promoção a ser cadastrada)
observacao<indice>: <caracter>, Observação da promoção

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Produto criado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar o produto. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de um produto já cadastrado.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = produtos): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_produto: <inteiro>, Identificador do produto a ser editado, não pode ser alterado, (obrigatório)
codbarra: <caracter>, Código de barras do produto, tamanho máximo = 20, (obrigatório)
cod_fabricante: <caracter>, Código do fabricante do produto, tamanho máximo = 20
nome_produto_1: <caracter>, Nome do produto, tamanho máximo = 255, (obrigatório)
descricao_produto_1: <caracter>, Descrição do produto,
unidademedida: <caracter>, Unidade de medida do produto, tamanho máximo = 6, (obrigatório)
lista_grupos: <caracter>, JSON contendo os grupos ligados ao produto (default = {})
peso_bruto: <decimal>, Peso bruto do produto
peso_liquido: <decimal>, Peso líquido do produto
largura: <decimal>, Largura do produto
comprimento: <decimal>, Comprimento do produto
altura: <decimal>, Altura do produto
preco_venda: <decimal>, Preço de venda do produto, (obrigatório)
preco_lojista: <decimal>, Preço do lojista do produto
estoque: <decimal>, Quantidade em estoque do produto
ativo: <inteiro>, Status de produto ativo, (obrigatório - 0 ou 1), (default = 1)
prazo_producao: <inteiro>, Número de dias que levará para a produção, caso o produto tenha estoque igual a zero
cod_original: <caracter>, código do produto, que é utilziando pelo esoft, tamanho máximo = 15
imagem: <caracter>, Imagem convertida em base64 do produto (para excluir a imagem, basta informar "remover", no campo imagem)
preco_custo: <decimal>, Preço de custo do produto
estoque_minimo: <decimal>, Estoque mínimo do produto
estoque_maximo: <decimal>, Estoque máximo do produto
margem_lucro: <decimal>, Margem de lucro do produto
tipo_produto: <caracter>, Tipo do produto, tamanho máximo = 1, (V = venda, R = revenda, S = serviço)
descontar_icms_desonerado: <inteiro>, Status de produto a descontar ICMS desonerado, (0 ou 1)
id_fornecedor: <inteiro>, Identificador do fornecedor do produto
id_classificacao_fiscal: <caracter>, Classificação fiscal do produto
promocao: <caracter>, Status de promoção habilitada para este produto, tamanho máximo = 1, (S ou N, default=N - para cadastrar uma promoção é obrigatório que este campo esteja setado com 'S')

Os campos abaixo são referentes a criação/edição de uma promoção vinculada a este produto.
Para cada promoção, deve-se criar um grupo de campos abaixo, adicionando o índice de cada promoção, começando por 1. Ex: (estoque_promocao1, estoque_promocao2, ...).
Estes campos não são obrigatórios.
Só utilize o campo id_promocao caso queira editar uma promoção.
Caso o produto possua promoções, e os campos abaixo não forem informados, a promoção vinculada será exlcuída.
Para que a promoção continue vinculada, mesmo que sem edição dos dados, é necessário informar os dados da promoção nos campos abaixo.
id_promocao: <inteiro>, Identificador da promoçãoa a ser editada, não pode ser alterado, (obrigatório, caso seja feita a edição de uma promoção)
estoque_promocao<indice>: <decimal>, Estoque da promoção (Se estiver = 0, o estoque é ilimitado para a promoção. Caso contrário, deverá limitar a essa quantidade e checar isso no momento de gravar a venda no app), (obrigatório - em caso de houver promoção a ser cadastrada)
dt_usoini<indice>: <caracter>, Data inicial da promoção, tamanho máximo = 10, (utilizar o padrão DD/MM/AAAA), (obrigatório - em caso de houver promoção a ser cadastrada)
dt_usofim<indice>: <caracter>, Data final da promoção, tamanho máximo = 10, (utilizar o padrão DD/MM/AAAA), (obrigatório - em caso de houver promoção a ser cadastrada)
precopromo<indice>: <decimal>, Preço da promoção, (obrigatório - em caso de houver promoção a ser cadastrada)
quantidade<indice>: <decimal>, Quantidade mínima da promoção (Se igual a 0 (zero), pode comprar qualquer quantidade. Se maior que 1, sistema deverá tratar a promoção de acordo com as unidades), (obrigatório - em caso de houver promoção a ser cadastrada)
observacao<indice>: <caracter>, Observação da promoção

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Produto alterado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar o produto. Verifique os campos"
}

ativar/inativar

Método responsável por ativar/inativar um produto.

URL:

DELETE http://erp.addmob.com.br/api/inativar

Parâmetros:

url (valor = produtos): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros obrigatórios (estes parâmetros são obrigatórios - formato [campo1=v1,campo2=v2]):

id_produto: recebe o identificador do produto
tipo: recebe a operação (ativar ou inativar)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Produto ativado/inativado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao ativar/inativar o produto"
}

Rotinas de Recuperação de senha de acesso

Contém os métodos de recuperação da senha de acesso, aos apps que utilizam esta api.

Método(s)

Enviar e-mail de recuperação

Envia um email com o código de recuperação.

URL:

GET http://erp.addmob.com.br/api/enviar_email_recuperacao_senha

Parâmetros:

email: recebe o e-mail, que é o login, na qual se deseja recuperar o acesso;

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": ""
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao enviar o e-mail"
}

Enviar código de recuperação

Envia o código de recuperação, para que seja verificado. Caso válido, possibilitar a recuperação da senha.

URL:

GET http://erp.addmob.com.br/api/verificar_codigo_recuperacao_senha

Parâmetros:

email: recebe o e-mail, que é o login, na qual se deseja recuperar o acesso;
codigo_recuperacao: recebe o código de recuperação, na qual será verificado;

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": ""
}
ou
{
  "status": "ERRO",
  "mensagem": "Código invalido"
}

Alterar senha de acesso ao App

Envia a nova senha, para que seja alterada a senha de acesso ao App.

URL:

POST http://erp.addmob.com.br/api/alterar_senha_acesso_app

Parâmetros:

email: recebe o e-mail, que é o login, na qual se deseja recuperar o acesso;
codigo_recuperacao: recebe o código de recuperação;
password: recebe a nova senha de acesso ao app. Esta senha deve estar criptografada, em formato de octeto de bits, separados por vírgula (ex: '01111110,00001111,00110001').

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": ""
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar a senha"
}

Módulo Promoções

Contém os métodos de manipulação de uma Promoção no sistema PortalERP.

Método(s)

listar

lista todas as promoções cadastradas.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[periodo_inicial=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[periodo_inicial>10])
<: obtém os dados menores que o valor informado (ex: parametros=[periodo_inicial<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[periodo_inicial>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[periodo_inicial<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[periodo_inicial!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[periodo_inicial%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[periodo_inicial()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[periodo_inicial!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[periodo_inicial<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[periodo_inicial!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = promocoes): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

id_promocao: recebe o identificador da promoção
periodo_inicial: recebe o período inicial da promoção
periodo_final: recebe o período final da promoção
descricao: recebe a descrição da promoção
ativo: recebe o status de promoção ativa (padrão: sim ou nao)

Formato do retorno (JSON):

{
  "status": "OK", // Status de requisição bem sucedida,
  "data": [{// Lista com as promoções retornadas na pesquisa.
    "id_promocao": "", // Identifcador da promoção
    "periodo_inicial": "", // Período inicial da promoção
    "periodo_final": "", // Período final da promoção
    "descricao": "", // Descrição da promoção
    "ativo": "", // Status de promoção ativa (ATIVO ou INATIVO)
    "lista_produtos": [{ // Lista de produtos ligadas a esta promoção
      "id_produto": "", // Identificador do produto
      "preco": "", // Preço do produto
    }]
  }]
}

criar

Método responsável pela criação de uma promoção.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = promocoes): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

periodo_inicial: <caracter>, data e hora do período inicial da promoção, (formato DD/MM/AAAA HH:MM), (obrigatório)
periodo_final: <caracter>, data e hora do período final da promoção, (formato DD/MM/AAAA HH:MM), (obrigatório)
descricao: <caracter>, Descrição da promoção, tamanho máximo = 255, (obrigatório)
ativo: <inteiro>, Status de promoção ativa, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Promoção criada com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar a promoção. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de uma promoção já cadastrada.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = promocoes): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_promocao: <inteiro> Identificação da promoção a ser editada, não pode ser alterado, (obrigatório)
periodo_inicial: <caracter>, data e hora do período inicial da promoção, (formato DD/MM/AAAA HH:MM), (obrigatório)
periodo_final: <caracter>, data e hora do período final da promoção, (formato DD/MM/AAAA HH:MM), (obrigatório)
descricao: <caracter>, Descrição da promoção, tamanho máximo = 255, (obrigatório)
ativo: <inteiro>, Status de promoção ativa, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Promoção alterada com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar a promoção. Verifique os campos"
}

ativar/inativar

Método responsável por ativar/inativar uma promoção.

URL:

DELETE http://erp.addmob.com.br/api/inativar

Parâmetros:

url (valor = promocoes): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros obrigatórios (estes parâmetros são obrigatórios - formato [campo1=v1,campo2=v2]):

id_promocao: recebe o identificador da promoção
tipo: recebe a operação (ativar ou inativar)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Promoção ativada/inativada com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao ativar/inativar a promoção"
}

Módulo Usuário

Contém os métodos de manipulação de um usuário de aplicativos do sistema PortalERP.

Método(s)

listar

lista todos os setores cadastrados.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Observação: Para listar apenas os setores ativos, é obrigatório utilizar o parâmetro ativo igual a "sim" (ex: parametros=[ativo=sim])

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = setores): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

id_setor: recebe o identificador do setor
nome_setor: recebe o nome do setor/li>
ativo: recebe o status de setor ativo (padrão: sim ou nao)

Formato do retorno (JSON):

{
  "status": "OK", // Status de requisição bem sucedida,
  "data": [{// Lista com os setores retornados na pesquisa.
    "nome_setor": "", // Nome do setor
    "id_setor": "", // Identificador do setor
    "ativo": "", // Status de setor ativo (ATIVO ou INATIVO)
  }]
}

criar

Método responsável pela criação de um setor.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = setores): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

nome_setor: <caracter>, Nome do setor, tamanho máximo = 50, (obrigatório)
ativo: <inteiro>, Status de setor ativo, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Setor criado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar o setor. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de um setor já cadastrado.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = setores): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_setor: <inteiro> identificador do setor a ser editado (obrigatório)
nome_setor: <caracter>, Nome do setor, tamanho máximo = 50, (obrigatório)
ativo: <inteiro>, Status de setor ativo, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Setor alterado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar o setor. Verifique os campos"
}

ativar/inativar

Método responsável por ativar/inativar um setor.

URL:

DELETE http://erp.addmob.com.br/api/inativar

Parâmetros:

url (valor = setores): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros obrigatórios (estes parâmetros são obrigatórios - formato [campo1=v1,campo2=v2]):

id_setor: recebe o identificador do setor
tipo: recebe a operação (ativar ou inativar)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Setor ativado/inativado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao ativar/inativar o setor"
}

Módulo Usuário

Contém os métodos de manipulação de um usuário de aplicativos do sistema PortalERP.

Método(s)

listar

lista todos os usuários cadastrados.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Observação: Para listar apenas os usuários ativos, é obrigatório utilizar o parâmetro ativo igual a "sim" (ex: parametros=[ativo=sim])

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = usuarios): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

email: recebe o email do usuário
nome: recebe o nome do usuário
cpf_cnpj: recebe o cpf ou cnpj do usuário
telefone: recebe o telefone do usuário
ativo: recebe o status de usuário ativo (padrão: sim ou nao)
id_cliente: recebe o identificador do cliente ligado a este usuário
cep: recebe o cep do usuário
endereco: recebe o endereço do usuário
numero: recebe o número do endereço do usuário
complemento: recebe o complemento do usuário
bairro: recebe o bairro do usuário
cidade: recebe a cidade do usuário
uf: recebe o UF do usuário
aceita_mkt: recebe o status de usuário que aceita receber e-mail, promoções e whatsapp (padrão: sim ou nao)

Formato do retorno (JSON):

{
  "status": "OK", // Status de requisição bem sucedida,
  "data": [{// Lista com os usuários retornados na pesquisa.
    "nome": "", // Nome do usuário (Razão Social)
    "id_cliente": "", // Identificador do cliente ligado a este usuário
    "cpf_cnpj": "", // CPF/CNPJ do usuário
    "telefone": "", // Telefone do usuário
    "ativo": "", // Status de usuário ativo (ATIVO ou INATIVO)
    "email": "", // E-mail do usuário, que é utilizado como username
    "cep": "", // Cep do usuário
    "endereco": "", // Endereço do usuário
    "numero": "", // Número do endereço do usuário
    "complemento": "", // Complemento do endereço do usuário
    "bairro": "", // Bairro do usuário
    "cidade": "", // Cidade do usuário
    "uf": "" // Estado (UF) do usuário
    "aceita_mkt": "" // Status de usuário que aceita receber e-mail, promoções e whatsapp
    "imagem": "", // localização (URL) da imagem deste usuário
    "inscricao_estadual": "", // Inscrição Estadual do usuário
    "nome_fantasia": "", // Nome Fantasia do usuário
    "instagram": "", // Endereço do perfil do Instagram do usuário
    "facebook": "", // Endereço do perfil do Facebook do usuário
    "cpf_responsavel": "", // CPF do responsável
    "nome_responsavel": "", // Nome do responsável
    "sexo": "", // Gênero do cliente
  }]
}

criar

Método responsável pela criação de um usuário.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = usuarios): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

email: <caracter>, E-mail do usuário, tamanho máximo = 100, (obrigatório. Este campo é usado como campo de login - username)
password: <caracter>, Senha criptografada do usuário, (obrigatório)
nome: <caracter>, Nome do usuário (Razão Social), tamanho máximo = 100, (obrigatório)
cpf_cnpj: <caracter>, CPF/CNPJ do usuário, tamanho máximo = 14
telefone: <caracter>, Telefone do usuário, tamanho máximo = 14, (obrigatório, enviar sem máscara)
ativo: <inteiro>, Status de grupo de produtos ativo, (obrigatório - 0 ou 1), (default = 1)
cep: <caracter>, Cep do endereço do usuário, tamanho máximo = 9
endereco: <caracter>, Endereço do usuário, tamanho máximo = 90
numero: <inteiro>, Número do endereço do usuário
complemento: <caracter>, Complemento do endereço do usuário, tamanho máximo = 90
bairro: <caracter>, Bairro do usuário, tamanho máximo = 90
cidade: <caracter>, Nome da cidade do usuário, tamanho máximo = 100
uf: <caracter>, Estado(UF) do usuário, tamanho máximo = 2
aceita_mkt: <caracter>, status de usuário que aceita receber e-mail, promoções e whatsapp (padrão: sim ou nao), tamanho = 1, (default = 0)
imagem: <caracter>, imagem convertida em base64 do cliente
inscricao_estadual: <caracter>, Inscrição Estadual do usuário, tamanho máximo = 20
nome_fantasia: <caracter>, Nome Fantasia do usuário, tamanho máximo = 100
instagram: <caracter>, Endereço do perfil do Instagram do usuário
facebook: <caracter>, Endereço do perfil do Facebook do usuário
cpf_responsavel: <caracter>, CPF do responsável, tamanho máximo = 14
nome_responsavel: <caracter>, Nome do responsável, tamanho máximo = 100
sexo: <caracter>, Gênero do cliente, tamanho máximo = 1

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Grupo criado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar o grupo. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de um usuário já cadastrado.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = usuarios): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_cliente: <inteiro> identificador do cliente ligado ao usuário a ser editado (obrigatório quando houver cliente vinculado)
email: <caracter>, E-mail do usuário, tamanho máximo = 100, (obrigatório. Este campo é usado como campo de login - username)
password: <caracter>, Senha criptografada do usuário, (obrigatório)
nome: <caracter>, Nome do usuário (Razão Social), tamanho máximo = 100, (obrigatório)
cpf_cnpj: <caracter>, CPF/CNPJ do usuário, tamanho máximo = 14
telefone: <caracter>, Telefone do usuário, tamanho máximo = 14, (obrigatório, enviar sem máscara)
ativo: <inteiro>, Status de grupo de produtos ativo, (obrigatório - 0 ou 1), (default = 1)
cep: <caracter>, Cep do endereço do usuário, tamanho máximo = 9
endereco: <caracter>, Endereço do usuário, tamanho máximo = 90
numero: Número do endereço do usuário, <inteiro>
complemento: <caracter>, Complemento do endereço do usuário, tamanho máximo = 90
bairro: <caracter>, Bairro do usuário, tamanho máximo = 90
cidade: <caracter>, Nome da cidade do usuário, tamanho máximo = 100
uf: <caracter>, Estado(UF) do usuário, tamanho máximo = 2
aceita_mkt: <caracter>, status de usuário que aceita receber e-mail, promoções e whatsapp (padrão: sim ou nao), tamanho = 1, (default = 0)
imagem: <caracter>, imagem convertida em base64 do cliente (para excluir a imagem, basta informar "remover", no campo imagem)
inscricao_estadual: <caracter>, Inscrição Estadual do usuário, tamanho máximo = 20
nome_fantasia: <caracter>, Nome Fantasia do usuário, tamanho máximo = 100
instagram: <caracter>, Endereço do perfil do Instagram do usuário
facebook: <caracter>, Endereço do perfil do Facebook do usuário
cpf_responsavel: <caracter>, CPF do responsável, tamanho máximo = 14
nome_responsavel: <caracter>, Nome do responsável, tamanho máximo = 100
sexo: <caracter>, Gênero do cliente, tamanho máximo = 1

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Usuario alterado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar o usuario. Verifique os campos"
}

ativar/inativar

Método responsável por ativar/inativar um usuário.

URL:

DELETE http://erp.addmob.com.br/api/inativar

Parâmetros:

url (valor = usuarios): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros obrigatórios (estes parâmetros são obrigatórios - formato [campo1=v1,campo2=v2]):

id_grupo: recebe o identificador do grupo
tipo: recebe a operação (ativar ou inativar)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Usuario ativado/inativado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao ativar/inativar o usuario"
}

Módulo Veiculos

Contém os métodos de manipulação de veiculos do sistema PortalERP.

Método(s)

listar

lista todos os veiculos cadastrados.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Observação: Para listar apenas os veiculos ativos, é obrigatório utilizar o parâmetro ativo igual a "sim" (ex: parametros=[ativo=sim])

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = veiculos ): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

id_veiculo: recebe o identificador do veiculo
id_marca: recebe o identificador da marca do veiculo
nome_marca: recebe o nome da marca do veiculo
id_modelo: recebe o identificador do modelo
nome_modelo: recebe o nome do modelo do veiculo
id_cliente: recebe o identificador do cliente
nome_cliente: recebe o nome do cliente
cod_veiculo_original: recebe o código original do veiculo, que é utilziando pelo esoft
placa: recebe a placa do veiculo
cor: recebe a cor do veiculo
renavam: recebe a renavam do veiculo
numero_chassi: recebe o numero do chassi do veiculo
cilindradas: recebe as cilindradas do veiculo
combustivel: recebe o combustivel do veiculo
ano_fabricacao: recebe o ano de fabricação do veiculo
ano_modelo: recebe o ano do modelo do veiculo
ativo: recebe o status de veiculo ativo (padrão: sim ou nao)

Formato do retorno (JSON):

{
  "status": "OK", // Status de requisição bem sucedida,
  "data": [{// Lista com as veiculos retornadas na pesquisa.
    "id_veiculo": "", // Identificador do veiculo
    "id_marca": "", // Identificador da marca do veiculo
    "nome_marca": "", // Nome da marca do veiculo
    "id_cliente": "", // Identificador do cliente
    "nome_cliente": "", // Nome do cliente
    "cod_veiculo_original": "", // Código original do veiculo, que é utilizado pelo esoft
    "placa": "", // Placa do veiculo
    "cor": "", // cor do veiculo
    "renavam": "", // Renavam do veiculo
    "numero_chassi": "", // Numero do chassi do veiculo
    "cilindradas": "", // Numero de cilindradas do veiculo
    "combustivel": "", // Nome do tipo de combustivel utilizado pelo veiculo
    "ano_fabricacao": "", // Ano de fabricação do veiculo
    "ano_modelo": "", // Ano do modelo do veiculo
    "ativo": "", // Status de veiculo ativo (ATIVO ou INATIVO)
  }]
}

criar

Método responsável pela criação de um veiculo.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = veiculos ): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_marca: <inteiro>, Identificador da marca, tamanho máximo = 11, (obrigatório)
id_modelo: <inteiro>, Identificador do modelo, tamanho máximo = 11, (obrigatório)
id_cliente: <inteiro>, Identificador do cliente, tamanho máximo = 11, (obrigatório)
cod_veiculo_original: <caracter>, Código do veiculo original, tamanho máximo = 5, (obrigatório)
placa: <caracter>, Identificador da marca, tamanho máximo = 7
cor: <caracter>, Nome da cor do veiculo, tamanho máximo = 20
renavam: <caracter>, Numero do renavam do veiculo, tamanho máximo = 11
numero_chassi: <caracter>, Numero do chassi do veiculo, tamanho máximo = 17
cilindradas: <inteiro>, Numero de cilindradas do veiculo, tamanho máximo = 4
combustivel: <caracter>, Nome do tipo de combustivel utilizado pelo veiculo, tamanho máximo = 10
ano_fabricacao: <inteiro>, Ano de fabricação do veiculo, tamanho máximo = 4
ano_modelo: <inteiro>, Ano do modelo do veiculo, tamanho máximo = 4
ativo: <inteiro>, Status de veiculo ativo, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Veiculo criado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar o veiculo. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de um veiculo já cadastrada.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = veiculos ): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_veiculo: <inteiro> identificador do veiculo a ser editado (obrigatório)
id_marca: <inteiro>, Identificador da marca, tamanho máximo = 11, (obrigatório)
id_modelo: <inteiro>, Identificador do modelo, tamanho máximo = 11, (obrigatório)
id_cliente: <inteiro>, Identificador do cliente, tamanho máximo = 11, (obrigatório)
cod_veiculo_original: <caracter>, Código do veiculo original, tamanho máximo = 5, (obrigatório)
placa: <caracter>, Identificador da placa, tamanho máximo = 7
cor: <caracter>, Nome da cor do veiculo, tamanho máximo = 20
renavam: <caracter>, Numero do renavam do veiculo, tamanho máximo = 11
numero_chassi: <caracter>, Numero do chassi do veiculo, tamanho máximo = 17
cilindradas: <inteiro>, Numero de cilindradas do veiculo, tamanho máximo = 4
combustivel: <caracter>, Nome do tipo de combustivel utilizado pelo veiculo, tamanho máximo = 10
ano_fabricacao: <inteiro>, Ano de fabricação do veiculo, tamanho máximo = 4
ano_modelo: <inteiro>, Ano do modelo do veiculo, tamanho máximo = 4
ativo: <inteiro>, Status de veiculo ativo, (obrigatório - 0 ou 1), (default = 1)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Veiculo alterado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar o Veiculo. Verifique os campos"
}

ativar/inativar

Método responsável por ativar/inativar um veiculo.

URL:

DELETE http://erp.addmob.com.br/api/inativar

Parâmetros:

url (valor = veiculos ): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros obrigatórios (estes parâmetros são obrigatórios - formato [campo1=v1,campo2=v2]):

id_veiculo: recebe o identificador do veiculo
tipo: recebe a operação (ativar ou inativar)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Veiculo ativado/inativado com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao ativar/inativar o Veiculo"
}

Módulo Venda

Contém os métodos de manipulação de uma venda no sistema PortalERP.

Método(s)

listar

lista todas as vendas cadastradas.

URL:

GET http://erp.addmob.com.br/api/listar

Parâmetros:

Tipos de Pesquisa: Você pode fazer uma pesquisa utlizando os seguinte operadores:

=: obtém os dados iguais ao valor informado (ex: parametros=[preco=10])
>: obtém os dados maiores que o valor informado (ex: parametros=[preco>10])
<: obtém os dados menores que o valor informado (ex: parametros=[preco<10])
>=: obtém os dados maiores ou igual ao valor informado (ex: parametros=[preco>=10])
<=: obtém os dados menores ou igual ao valor informado (ex: parametros=[preco<=10])
!=: obtém os dados diferentes que o valor informado (ex: parametros=[preco!=10])
%%: obtém os dados que possuem o valor informado em seu conteúdo, semelhante ao operador SQL LIKE %% (ex: parametros=[preco%%10])
(): obtém os dados que possuem valores iguais aos valores informados, semelante ao operador SQL IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco()10@20])
!(): obtém os dados que possuem valores diferentes aos valores informados, semelante ao operador SQL NOT IN (). Utilize o caracter @ como separador de valores (ex: parametros=[preco!()10@20])
<>: obtém os dados que possuem valores dentro da faixa de valores informados, semelante ao operador SQL BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco<>10@20])
!<>: obtém os dados que possuem valores fora da faixa de valores informados, semelante ao operador SQL NOT BETWEEN. Utilize o caracter @ como separador de valores (ex: parametros=[preco!<>10@20])

Parâmetros do corpo da requisição GET:

url (valor = vendas): recebe o nome do módulo a ser utilizado;
parametros: recebe um array de parâmetros do filtro de pesquisa (estes parâmetros são opcionais - formato [campo1=v1,campo2=v2]):

cod_venda: recebe o código da venda
nome_cliente: recebe o nome do cliente
data_hora: recebe a data e hora da venda
preco_total_pedido: recebe o preço total do venda
forma_pagamento: recebe a forma de pagamento
id_mesa_celular_ident: recebe o identificador da mesa (modo CardápioShow)
id_celular: recebe o identificador do celular (modo CardápioShow)
id_garcom: recebe o identificador do garçóm (modo CardápioShow)
valoracrescimo: recebe o valor do acréscimo total da venda
valordesconto: recebe o valor do desconto total da venda
valordinheiro: recebe o valor em dinheiro da venda
valordebito: recebe o valor em débito da venda
valorcredito: recebe o valor em crédito da venda
valorcheque: recebe o valor em cheque da venda
valortroco: recebe o valor do troco da venda
valorbruto: recebe o valor bruto da venda
cancelado: recebe o status de venda cancelada

Formato do retorno (JSON):

{
  "status": "OK", // Status de requisição bem sucedida,
  "data": [{// Lista com os usuários retornados na pesquisa.
    "nome": "", // Nome do usuário (Razão Social)
    "cod_venda": "", // Código da venda
    "data_hora": "", // Data e hora da venda
    "forma_pgto": "", // Código da forma de pagamento
    "id_cliente": "", // Identificador do cliente
    "itens": [ "", // Lista de itens da venda
      {
        "acrescimo_rateado": "", // Valor do aréscimo rateado da venda
        "codbarra": "", // Código de barras do produto da venda
        "desconto_rateado": "", // Valor do desconto rateado da venda
        "frete_rateado": "", // Valor do frete rateado da venda
        "id_produto": "", // Identificador do produto da venda
        "preco": "", // Preço do item da venda
        "produto": "", // Nome do produto da venda
        "quantidade": "", // Quantidade do item da venda
      }
    ],
    "observacao": "", // Observação da venda
    "total": "", // Valor total da venda (líquido)
    "vlr_info_car": "", // Valor da venda (cartão)
    "vlr_info_che": "", // Valor da venda (cheque)
    "vlr_info_cre": "", // Valor da venda (crédito)
    "vlr_info_din": "", // Valor da venda (dinheiro)
    "vlr_info_pra": "" // Valor da venda (à prazo)
  }]
}

criar

Método responsável pela criação de uma venda.

URL:

POST http://erp.addmob.com.br/api/criar

Parâmetros:

url (valor = vendas): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

id_cliente: <inteiro>, identificador do cliente, (obrigatório)
observacao: <caracter>, observação da venda
data_venda: <caracter>, data e hora da venda, (formato DD/MM/AAAA HH:MM), (obrigatório)
data_saida: <caracter>, data e hora da saída da venda, (formato DD/MM/AAAA HH:MM)
total: <decimal>, total líquido da venda, (obrigatório)
forma_pgto: <caracter>, identificador da forma de pagamento, tamanho máximo = 1, (obrigatório), (default = 0)
numero_parcelas_total: <inteiro>, número de parcelas da venda, caso seja venda à prazo, (obrigatório), (default = 0)
vlr_info_din: <decimal>, valor da venda em dinheiro
vlr_info_pra: <decimal>, valor da venda em à prazo
vlr_info_che: <decimal>, valor da venda em cheque
vlr_info_car: <decimal>, valor da venda em cartão
vlr_info_cre: <decimal>, valor da venda em crédito

parcelas: <lista>, recebe as parcelas da venda, caso seja pagamento à prazo, (default = [])
- Elementos da lista de parcelas:
parcela: <decimal>, valor da parcela, (obrigatório caso exista uma parcela)
data: <caracter>, data da parcela, (formato DD/MM/AAAA HH:MM), (obrigatório caso exista uma parcela)

itens: <lista>, recebe os itens da venda (obrigatório)
- Elementos da lista de itens da venda:
id_produto: <inteiro>, identificador do produto, (obrigatório)
preco: <decimal>, preço do produto, (obrigatório)
quantidade: <decimal>, quantidade do produto, (obrigatório)
valor_desconto: <decimal>, valor de desconto do produto, (obrigatório), (default = 0)
desconto_rateado: <decimal>, valor rateado de desconto do produto, (obrigatório), (default = 0)
acrescimo_rateado: <decimal>, valor rateado de acrścimo do produto, (obrigatório), (default = 0)
frete_rateado: <decimal>, valor rateado de frete do produto, (obrigatório), (default = 0)
total_liquido: <decimal>, total líquido do produto, (obrigatório)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Venda criada com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao gravar a venda. Verifique os campos"
}

editar

Método responsável pela alteração dos dados de uma venda já cadastrada.

URL:

POST http://erp.addmob.com.br/api/editar

Parâmetros:

url (valor = vendas): recebe o nome do módulo a ser utilizado.

Parâmetros do corpo da requisição POST:

cod_venda: <caracter> código da venda a ser editada, não pode ser alterado, (obrigatório)
id_cliente: <inteiro>, identificador do cliente, (obrigatório)
observacao: <caracter>, observação da venda
data_venda: <caracter>, data e hora da venda, (formato DD/MM/AAAA HH:MM), (obrigatório)
data_saida: <caracter>, data e hora da saída da venda, (formato DD/MM/AAAA HH:MM)
total: <decimal>, total líquido da venda, (obrigatório)
forma_pgto: <caracter>, identificador da forma de pagamento, tamanho máximo = 1, (obrigatório), (default = 0)
numero_parcelas_total: <inteiro>, número de parcelas da venda, caso seja venda à prazo, (obrigatório), (default = 0)
vlr_info_din: <decimal>, valor da venda em dinheiro
vlr_info_pra: <decimal>, valor da venda em à prazo
vlr_info_che: <decimal>, valor da venda em cheque
vlr_info_car: <decimal>, valor da venda em cartão
vlr_info_cre: <decimal>, valor da venda em crédito

parcelas: <lista>, recebe as parcelas da venda, caso seja pagamento à prazo, (default = [])
- Elementos da lista de parcelas:
parcela: <decimal>, valor da parcela, (obrigatório caso exista uma parcela)
data: <caracter>, data da parcela, (formato DD/MM/AAAA HH:MM), (obrigatório caso exista uma parcela)

itens: <lista>, recebe os itens da venda (obrigatório)
- Elementos da lista de itens da venda:
id_produto: <inteiro>, identificador do produto, (obrigatório)
preco: <decimal>, preço do produto, (obrigatório)
quantidade: <decimal>, quantidade do produto, (obrigatório)
valor_desconto: <decimal>, valor de desconto do produto, (obrigatório), (default = 0)
desconto_rateado: <decimal>, valor rateado de desconto do produto, (obrigatório), (default = 0)
acrescimo_rateado: <decimal>, valor rateado de acrścimo do produto, (obrigatório), (default = 0)
frete_rateado: <decimal>, valor rateado de frete do produto, (obrigatório), (default = 0)
total_liquido: <decimal>, total líquido do produto, (obrigatório)

Formato do retorno (JSON):

{
  "status": "OK",
  "mensagem": "Venda alterada com sucesso"
}
ou
{
  "status": "ERRO",
  "mensagem": "Erro ao alterar a venda. Verifique os campos"
}

Módulo Distância Parceiros

Contém os métodos de utilização da API para calcular a distância dos parceiros dos clientes.

Método(s)

calcular_distancia

Calcula a distância.

URL:

POST http://erp.addmob.com.br/api/calcular_distancia

Parâmetros do corpo da requisição POST:

user_lat: <decimal>, recebe o latitude do cliente
user_long: <decimal>, recebe o longitude do cliente
dest_lat: <decimal>, recebe o latitude do parceiro
dest_long: <decimal>, recebe o longitude do parceiro

Formato do retorno (JSON):

{
"mensagem": "3115.1 km", // Distância em km,
"status": "OK" // Status de requisição bem sucedida,
}