Descrição API Arenaplan com ERP
É possível que qualquer tipo de aplicação possa ser integrada com nosso PDV via API. Através de nossa API sua Retaguarda ou ERP, de qualquer tipo ou automação comercial do mercado pode utilizar nosso PDV Portátil e alimentar as informações em sua aplicação. O PDV Arenaplan atuará como terminal emissor de nota fiscal, mantendo a retaguarda original do cliente. A maneira mais simples é utilizar nossa retaguarda simplificada para realizar cadastro dos produtos, estoque, grupos fiscais e clientes e importar os produtos, clientes e vendas atualizadas no final do dia. Você poderá virar nosso parceiro/revenda e ainda transformar suas revendas em revendas Arenaplan podendo acrescentar recursos como contas a pagar e receber, sped fiscal, cadastro de fornecedores, gestão de compras, fluxo de caixa e etc.- API 01 - Carrega código, valor, nome dos produtos e informações fiscais (API)
- Envia código do parceiro, usuário e terminal e retorna dados de cada produto cadastrado para ser carregado no ERP do Parceiro. Este procedimento deve executado uma vez, se foi executado mudança na tabela de preços ou inclusão de novos produtos.
Exemplo de consulta em Ambiente de Homologação:
parâmetros descrição t_login=USUARIO login para usuário de API (fornecido pela Arenaplan) t_passw=SENHA senha para usuário de API (fornecido pela Arenaplan) t_hh_ident=99999 identificação do TERMINAL no registro (fornecido pela Arenaplan) t_action=carrega_produtos_erp ação solicitada à API t_formato=xml Formato de saida dos dados (json ou xml) Exemplo de resposta
Se a escolha for pela resposta em formato "xml" a resposta seria semelhante a esta:<cards> <card> <produtos> <produto> <pi>11</pi> <nr>Agua de Coco</nr> <vr>8.00</vr> <td>1</td> <cb>019954056469</cb> <un>UN</un> <ncm>22030000</ncm> <cest>0100600</cest> <est>4461</est> <cfop>5102</cfop> <csticms>102</csticms> <aliqicms>0</aliqicms> <redb_icms>0</redb_icms> <cstpis>01</cstpis> <aliqpis>0.65</aliqpis> <cstcofins>01</cstcofins> <aliqcofins>3</aliqcofins> <ativo>1</ativo> </produto> <produto> ..... </produtos> <error_code>00</error_code> <elapsed_time>0.00</elapsed_time> </card> </cards>
Se a escolha for pela resposta em formato "json" a resposta seria semelhante a esta:
{
"produtos":
[
[
{
"pi":"1",
"nr":"Cafezinho",
"vr":"1.00",
"td":1,
"cb":"019954056469",
"un":"UN",
"ncm":"22030000",
"cest":"0100600",
"est":"4461",
"cfop":5102,
"csticms":102,
"aliqicms":0,
"redb_icms":0,
"cstpis":"01",
"aliqpis":0.65,
"cstcofins":"01",
"aliqcofins":3,
"ativo":"1"
},
{
...
}
]
],
"error_code":"00"
}Para cada tipo de produto encontrado será retornada uma lista de produtos encontrados, cada produto com as seguintes informações
parâmetros descrição pi ID do produto nr Nome do produto vr Valor do produto em reais td ID da categoria do produto cb Codigo de barras (Ean) un Unidade do Produto ncm NCM do produto cest CEST do produto est Estoque Atual do Produto cfop CFOP do produto csticms CST DO ICMS aliqicms Aliquota ICMS redb_icms Percentual Redução da base de calculo cstpis CST PIS aliqpis Aliquota do PIS cstcofins CST COFINS aliqcofins Aliquota do COFINS inativo Status esta inativo (0) ou Ativo (1) error_code Status de Erro - Tabela Abaixo
- API 02 - Carrega dados dos clientes (API)
- Envia código do parceiro, usuário e terminal e retorna dados completos dos clientes, cpf/cnpj, nome, endereço, cidade, saldo do prepago, pontos acumulados, código da cidade e estado.
Exemplo de consulta em Ambiente de Homologação:
parâmetros descrição t_login=USUARIO login para usuário de API t_passw=SENHA senha para usuário de API t_hh_ident=99999 identificação do HH no registro correspondente do BO t_action=carrega_clientes_erp ação solicitada à API t_formato=xml Formato de saida dos dados (json ou xml) Exemplo de resposta
Se a escolha for pela resposta em formato "xml" a resposta seria semelhante a esta:<cards> <card> <clientes> <cliente> <id>143</id> <nome>convidado35</nome> <email>This email address is being protected from spambots. You need JavaScript enabled to view it.</email> <ativo>1</ativo> <saldo>7.52</saldo> <cpf>00000000035</cpf> <datanasc>1966-02-25</datanasc> <celular>11994494696</celular> <sexo>M</sexo> <endereco>av.paulista</endereco> <numero>123</numero> <complemento>sl.102</complemento> <bairro>Jardins</bairro> <cidade>São Paulo</cidade> <uf>SP</uf> <cep>0</cep> <2014-12-10 00:25:55> <pontos>39.98</pontos> <munid>3550308</munid> <ufid>35</ufid> </cliente> <cliente> <id>306</id> <nome>presente</nome> <email>ggg@dddd</email> <ativo>1</ativo> <saldo>.00</saldo> <cpf>50766723143</cpf> <celular>1111</celular> <sexo>M</sexo> <endereco> </endereco> <numero> </numero> <complemento> </complemento> <bairro> </bairro> <cidade>S?Paulo</cidade> <uf>SP</uf> <cep>01000-000</cep> <pontos>0.00</pontos> <munid>3550308</munid> <ufid>35</ufid> </cliente> <cliente> ..... </cliente> </clientes> <error_code>00</error_code> </card> </cards>
Se a escolha for pela resposta em formato "json" a resposta seria semelhante a esta:
{
"clientes":
[
[
{"id":"143",
"nome":"convidado35",
"email":"This email address is being protected from spambots. You need JavaScript enabled to view it.",
"ativo":"1",
"saldo":"7.52",
"cpf":"00000000035",
"datanasc":"1966-02-25",
"celular":"11994494696",
"sexo":"M",
"endereco":"av.paulista",
"numero":"123",
"complemento":"sl.102",
"bairro":"Jardins",
"cidade":"São Paulo",
"uf":"SP",
"cep":"01000-000",
"datainc":{"date":"2014-12-10 00:25:55.100000","timezone_type":3,"timezone":"America\/Sao_Paulo"},
"pontos":"39.98",
"munid":"3550308",
"ufid":35
},
{"id":"306",
"nome":"presente",
"email":"ggg@dddd",
"ativo":"1",
"saldo":".00",
"cpf":"50766723143",
"datanasc":{"date":"2017-01-17 00:00:00.000000","timezone_type":3,"timezone":"America\/Sao_Paulo"},
"celular":"1111",
"sexo":"M",
"endereco":" ",
"numero":" ",
"complemento":" ",
"bairro":" ",
"cidade":null,
"uf":"SP",
"cep":"0",
"datainc":{"date":"2017-01-17 11:08:31.247000","timezone_type":3,"timezone":"America\/Sao_Paulo"},
"pontos":".00",
"munid":"3550308",
"ufid":35
},
...
]
],
"error_code":"00"
}
Para cada tipo de produto encontrado será retornada uma lista de produtos encontrados, cada produto com as seguintes informações
parâmetros descrição id ID do cliente nome Nome/Sobrenome ou Razao social do cliente ativo Status do Cliente (1 ativo ou 0 inativo) saldo saldo do cartão pré-pago cpf Cpf/Cnpj do cliente datanasc Data de Nascimento/Abertura da Empresa celular Celular do cliente sexo Sexo do Cliente endereco Endereco numero Numero do cliente complemento Complemento bairro Bairro cidade Cidade do cliente uf Estado do cliente cep CEP do cliente datainc Data de Inclusão na base pontos Pontos Acumulados com Pre-pago munid Codigo do municipio ufid Código do Estado error_code Status de Erro - Tabela Abaixo
- API 03 - Carrega vendas do dia (API)
- Envia código do parceiro, usuário e terminal e retorna dados das vendas, valores, produtos, quantidade, chave e protocolo do sefaz.
Exemplo de consulta em Ambiente de Homologação:
parâmetros descrição t_login=USUARIO login para usuário de API t_passw=SENHA senha para usuário de API t_hh_ident=9999 identificação do HH no registro correspondente do BO t_data_ini=2017-01-19 data de inicio (opcional. Se omitidos usa a data corrente) t_data_fim=2017-01-19 data de fim (opcional). Se omitidos usa a data corrente t_action=carrega_vendas_erp ação solicitada à API t_formato=xml Formato de saida dos dados (json ou xml) Exemplo de resposta
Se a escolha for pela resposta em formato "xml" a resposta seria semelhante a esta:<cards> <card> <vendas> <venda> <idven>15611</idven> <serie>17</serie> <data>2017-04-10 00:19:25</data> <valor>10.00</valor> <desc>0</desc> <liq>10</liq> <sts>T</sts> <tipo>Credito</tipo> <cpf>00000000000</cpf> <oper>Visa</oper> <nsu>1234567</nsu> <aut>233434</aut> <mod>A Vista</mod> <parc>1</parc> <finan>E</finan> <chav>35170468336932000143650170000156111170423454</chav> <prot>135170000062176</prot> <carrinho> <idp>0000000000002</idp> <qtd>00001</qtd> <vlr>10.00</vlr> </carrinho> </venda> <venda> <idven>15613</idven> <serie>17</serie> <data>2017-04-10 12:29:31</data> <valor>20.00</valor> <desc>0</desc> <liq>10</liq> <sts>T</sts> <tipo>Dinheiro</tipo> <cpf>00000000000</cpf> <oper>0</oper> <nsu>0</nsu> <aut>-</aut> <mod>-</mod> <parc>1</parc> <finan>-</finan> <chav>35170468336932000143650170000156131170403814</chav> <prot>135170000062363</prot> <carrinho> <idp>0000000000002</idp> <qtd>00001</qtd> <vlr>10.00</vlr> <idp>0000000000006</idp> <qtd>00001</qtd> <vlr>10.00</vlr> </carrinho> </venda> <error_code>00</error_code> </card> </cards>
Para cada venda realizada transmitida para o SEFAZ será retornada uma lista de dados encontrados com as seguintes informações
parâmetros descrição idven IDFiscal da venda serie Serie do equipamento PDV data data da venda valor valor total bruto da venda desc Desconto aplicado sts Status (T-normal,C-Contingencia online, D-Contingencia Offline,X Cancelada, Z-Cancelada em contingencia,R-Rejeitada, I-Inutilizada,Y-Inutilizada em contingencia tipo Tipo da Venda (Dinheiro,Credito,Debito,Voucher,Mifare ou Cheque cpf CPF/CNPJ do cliente oper Operadora (Visa, Master, etc) nsu nsu do cartao aut autorizacao do cartao mod Modalidade do pagamento (A Vista ou Parcelado) idp IDentificador do produto vlr valor do produto prot Protocolo do Sefaz datainc Data de Inclusão na base pontos Pontos Acumulados com Pre-pago munid Codigo do municipio ufid Código do Estado error_code Status de Erro - Tabela Abaixo
- API 04 - Consulta o serviço no servidor para ver se está online. (API)
- Pode ser um teste para ver se o servidor esta no ar.
Exemplo de consulta:
parâmetros descrição t_login=USUARIO login para usuário de API (provisório) t_passw=SENHA senha para usuário de API (provisória) t_hh_ident=99999 identificação do TERMINAL no registro correspondente do BO t_action=echo ação solicitada à API
Tabela de Códigos de Status
código significado 00 OK A1 Erro - ação desconhecida A2 Erro - login falhou C2 Erro na consulta de produtos - quiosque não encontrado para o handheld_ident fornecido C3 Erro na consulta de produtos - erro ao consultar lista de produtos para o quiosque C4 Erro na consulta de produtos - erro ao consultar quiosque. C5 Erro na consulta de produtos - sem quiosque cadastrado L1 Erro na consulta de cliente - CPF de cliente não foi fornecido L2 Erro na consulta de cliente - Cliente não encontrado com o RFID fornecido U1 Erro de login - O hh_ident não foi fornecido U2 Erro de login - O usuário não foi encontrado U3 Erro de login - O login/senha não conferem Z1 Erro geral - a ação não foi processada outros algum erro