1. Maxx MLM
  2. API v.1
    1. Login
    2. Cadastros (Clientes)
    3. Consumidores
    4. Faturas (Pedidos)
    5. Faturas (Compras do CDR)
    6. Produtos
    7. Categorias
    8. Créditos

Maxx Marketing Multinível

Documentação da API

O Maxx MLM é uma solução completa para empresas que atuam ou desejam ingressar no mercado de Marketing Multinivel.

Ela possui todas as ferramentas necessárias para o seu negócio, incluindo: Cadastros de clientes, Rede Unilevel, Rede Binária, Loja Virtual, integração com módulos de pagamento, rotinas de bonificações e muito mais.

Atuamos no mercado de desenvolvimento, implantação e integração de Sistemas de Marketing Multinivel (MMN) a mais de 10 anos, o que nos credencia para fornecer uma solução de rápida implantação e grande confiabilidade.

Mercado:NS

A Mercado:NS é uma empresa que atua na área de Tecnologia da Informação desenvolvendo diversos tipos de sistemas. Somos referência e especialistas em Sistemas de Marketing Multinível (MMN), nosso carro-chefe é o MAXX MLM uma solução completa para empresas que atuam ou pretendem ingressar no mercado de MMN. Também desenvolvemos Lojas Virtuais, Redes VOIP, Aplicativos Móveis e Websites. Nosso diferencial é a inovação, agilidade, comprometimento, qualidade e suporte. Promovemos um atendimento e suporte diferenciado, sempre com o propósito de mantermos uma boa relação profissional afim de gerar experiências de sucesso para tantas empresas que buscam crescimento.

Login

  1. - Método AUTHAPIUSER




AUTHAPIUSER

MÉTODO authapiuser
DESCRIÇÃO Registra o usuário da API
PARAMETROS OBRIGATÓRIOS login (string)
senha (string)
PARAMETROS OPCIONAIS
URL /login/authapiuser
MÉTODO HTTP GET, POST, PUT, DELETE
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
RETORNO XML
EXEMPLO DE RETORNO 
<api>
	<request>
		<controller>login</controller>
		<action>authapiuser</action>
		<login>testApi</login>
		<module>default</module>
	</request>
	<response>
		<error>0</error>
		<token>17c4520f6cfa1ab53d8745e84681eb2917riezld2guv46oc3j</token>
		<msg>Usuário Autenticado Com Sucesso</msg>
	</response>
</api>

OBS.: O login deverá ser efetuado para começar a usar a API. Após o login, o sistema irá gerar um ‘token’ que será utilizado para acessar os demais métodos.





Cadastros (clientes)

  1. - Método LIST
  2. - Método FIND
  3. - Método PROFILE
  4. - Método LOGIN
  5. - Método STATUS




LIST

MÉTODO list
DESCRIÇÃO Retorna a lista os cadastros
PARAMETROS OBRIGATÓRIOS data_ini (string - data no formato Pt-Br)
token
PARAMETROS OPCIONAIS
URL /api/cadastros/list
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
	<request>
		<module>api</module>
		<controller>cadastros</controller>
		<action>list</action>
		<token>17c4520f6cfd1ab53d8745e84681eb555mgjb6zvl518tcf2s2</token>
	</request>
	<response>
		<error>0</error>
		<item>
			<login>login</login>
			<id>132</id>
			<tipo_cadastro>0</tipo_cadastro>
			<nome>Teste API</nome>
			<logradouro/>
			<endereco>Rua Estevão de Sá</endereco>
			<numero>333</numero>
			<complemento>AP 1</complemento>
			<bairro>Várzea</bairro>
			<cidade>Recife</cidade>
			<estado>PE</estado>
			<cep>50740-270</cep>
			<email>suporte@mercadons.com.br</email>
			<email_alternativo/>
			<telefone_residencial>(88) 88888-8888</telefone_residencial>
			<telefone_celular/>
			<operadora>Vivo</operadora>
			<melhor_operadora_regiao>Vivo</melhor_operadora_regiao>
			<sexo>M</sexo>
			<cpf>099.718.465-32</cpf>
			<cnpj/>
			<inscricao_estadual/>
			<nome_empresa/>
			<rg/>
			<data_nascimento>08/08/1990 00:00:00</data_nascimento>
			<cod_banco>341</cod_banco>
			<agencia>4446<agencia/>
			<tipo_conta>0</tipo_conta>
			<conta>3223-3<conta/>
			<cpf_conta>099.718.465-32</cpf_conta>
			<operacao>0</operacao>
			<variacao>0</variacao>
			<data_cadastro>12/07/2016 16:45:18</data_cadastro>
			<indicante_id>1</indicante_id>
			<data_ativacao>00/00/0000 00:00:00</data_ativacao>
			<id_nivel>0</id_nivel>
			<ip_cadastro>10.10.10.1</ip_cadastro>
			<pais>Brasil</pais>
			<cancelado>0</cancelado>
		</item>
	</response>
</api>




FIND

MÉTODO find
DESCRIÇÃO Retorna um cadastro
PARAMETROS OBRIGATÓRIOS cod (Int) ou cpf (String) ou cnpj (String)
token
PARAMETROS OPCIONAIS
URL /api/cadastros/find
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
	<request>
		<module>api</module>
		<controller>cadastros</controller>
		<action>find</action>
		<token>17c4520f6cfd1ab53d8745e841234b491mgjb6zvl518tKTcfds2</token>
		<cod>1</cod>
	</request>
	<response>
		<error>0</error>
		<login>id_1</login>
		<id>1</id>
		<tipo_cadastro>0</tipo_cadastro>
		<nome>ID_1</nome>
		<logradouro/>
		<endereco>rua 1</endereco>
		<numero>3</numero>
		<complemento/>
		<bairro>Centro</bairro>
		<cidade>Recife</cidade>
		<estado>PE</estado>
		<cep>22222-222</cep>
		<email>suporte@mercadons.com.br</email>
		<email_alternativo/>
		<telefone_residencial>(12) 3333-333</telefone_residencial>
		<telefone_celular>(12) 98888-8888</telefone_celular>
		<operadora/>
		<melhor_operadora_regiao>Claro</melhor_operadora_regiao>
		<sexo>M</sexo>
		<cpf>012.312.312-30</cpf>
		<cnpj/>
		<inscricao_estadual/>
		<nome_empresa/>
		<rg/>
		<data_nascimento>01/08/1990 00:00:00</data_nascimento>
		<cod_banco>38</cod_banco>
		<agencia>1212</agencia>
		<tipo_conta>0</tipo_conta>
		<conta>213123321</conta>
		<cpf_conta>0</cpf_conta>
		<operacao>0</operacao>
		<variacao>0</variacao>
		<data_cadastro>29/07/2015 13:12:50</data_cadastro>
		<indicante_id>0</indicante_id>
		<data_ativacao>05/01/2017 18:15:43</data_ativacao>
		<id_nivel>1</id_nivel>
		<ip_cadastro/>
		<pais>Brasil</pais>
		<cancelado>0</cancelado>
	</response>
</api>




PROFILE

(Retorna detalhes do cliente - para usuário/cliente autenticado no sistema)
MÉTODO profile
DESCRIÇÃO Retorna um cadastro
PARAMETROS OBRIGATÓRIOS token
PARAMETROS OPCIONAIS resumido (0 ou 1)
URL /api/cadastros/profile
MÉTODO HTTP POST
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
	<request>
		<module>api</module>
		<controller>cadastros</controller>
		<action>profile</action>
		<token>e8d43469efcc90e2c64d6c50c8e8912f260xwu4imn8cvkzbys</token>
	</request>
	<response>
		<error>0</error>
		<login>id_1</login>
		<id>1</id>
		<tipo_cadastro>0</tipo_cadastro>
		<nome>ID_1</nome>
		<logradouro/>
		<endereco>rua 1</endereco>
		<numero>3</numero>
		<complemento/>
		<bairro>Centro</bairro>
		<cidade>Recife</cidade>
		<estado>PE</estado>
		<cep>22222-222</cep>
		<email>suporte@mercadons.com.br</email>
		<telefone_residencial>(12) 3333-3333</telefone_residencial>
		<telefone_celular>(12) 98888-8888</telefone_celular>
		<cpf_cnpj>012.312.312-30</cpf_cnpj>
		<rg/>
		<data_nascimento>01/08/1990 00:00:00</data_nascimento>
		<cod_banco>38</cod_banco>
		<agencia>1212</agencia>
		<tipo_conta>0</tipo_conta>
		<conta>213123321</conta>
		<cpf_conta>0</cpf_conta>
		<operacao>0</operacao>
		<variacao>0</variacao>
		<pais>Brasil</pais>
		<cancelado>0</cancelado>
		<saldo_creditos>38882.4</saldo_creditos>
	</response>
</api>




PROFILE

(Retorna detalhes do cliente - para usuário/cliente autenticado no sistema)
MÉTODO profile
DESCRIÇÃO Retorna um cadastro
PARAMETROS OBRIGATÓRIOS token
PARAMETROS OPCIONAIS resumido (0 ou 1)
URL /api/cadastros/profile
MÉTODO HTTP POST
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
	<request>
		<module>api</module>
		<controller>cadastros</controller>
		<action>profile</action>
		<token>e8d43469efcc90e2c64d6c50c8e8912f260xwu4imn8cvkzbys</token>
	</request>
	<response>
		<error>0</error>
		<login>id_1</login>
		<id>1</id>
		<tipo_cadastro>0</tipo_cadastro>
		<nome>ID_1</nome>
		<logradouro/>
		<endereco>rua 1</endereco>
		<numero>3</numero>
		<complemento/>
		<bairro>Centro</bairro>
		<cidade>Recife</cidade>
		<estado>PE</estado>
		<cep>22222-222</cep>
		<email>suporte@mercadons.com.br</email>
		<telefone_residencial>(12) 3333-3333</telefone_residencial>
		<telefone_celular>(12) 98888-8888</telefone_celular>
		<cpf_cnpj>012.312.312-30</cpf_cnpj>
		<rg/>
		<data_nascimento>01/08/1990 00:00:00</data_nascimento>
		<cod_banco>38</cod_banco>
		<agencia>1212</agencia>
		<tipo_conta>0</tipo_conta>
		<conta>213123321</conta>
		<cpf_conta>0</cpf_conta>
		<operacao>0</operacao>
		<variacao>0</variacao>
		<pais>Brasil</pais>
		<cancelado>0</cancelado>
		<saldo_creditos>38882.4</saldo_creditos>
	</response>
</api>




LOGIN

MÉTODO login
DESCRIÇÃO Retorna um token temporário para logar o cliente
PARAMETROS OBRIGATÓRIOS cod (int - id do cliente)
token
PARAMETROS OPCIONAIS
URL /api/cadastros/login
MÉTODO HTTP POST
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
    <request>
        <module>api</module>
        <controller>cadastros</controller>
        <action>login</action>
        <token>17c4520f6cfd1ab53d8745e84681eb491de2utgfp9y3</token>
        <cod>1</cod>
    </request>
    <response>
        <error>0</error>
        <link>dev.maxxmultinivel.com.br/login/process/token/dccd96c256bc7dd39bae41a405f25e43260fij3d7cet6saywm</link>
    </response>
</api>




STATUS

MÉTODO status
DESCRIÇÃO Retorna o status de ativação do cadastro
PARAMETROS OBRIGATÓRIOS token
PARAMETROS OPCIONAIS cod (int - id do cliente)
cpf
cnpj
URL /api/cadastros/status
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
    <request>
        <module>api</module>
        <controller>cadastros</controller>
        <action>status</action>
        <token>17c4520f6cfd1ab53d8745e84681eb491de2utgfp9y3</token>
        <cod>1</cod>
    </request>
    <response>
        <error>0</error>
        <ativo>1</ativo>
        <data_ativacao>05/07/2018 16:06:50</data_ativacao>
        <ativo_ate>05/08/2018</ativo_ate>
    </response>
</api>

Consumidores

  1. - Método LIST
  2. - Método FIND
  3. - Método PROFILE




LIST

MÉTODO list
DESCRIÇÃO Retorna a lista os consumidores
PARAMETROS OBRIGATÓRIOS data_ini (string - data no formato Pt-Br)
token
PARAMETROS OPCIONAIS
URL /api/consumidores/list
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
	<request>
	<module>api</module>
	<controller>consumidores</controller>
	<action>list</action>
	<token>17c4520f6cf124353d8745e84681eb49194hkbnxiv321f278z</token>
	</request>
	<response>
	<error>0</error>
	<item>
	<login>id_14</login>
	<id>1</id>
	<tipo>0</tipo>
	<nome>João da Silva</nome>
	<endereco>R. Salvador de Sá</endereco>
	<numero>2</numero>
	<complemento/>
	<bairro>Várzea</bairro>
	<cidade>Recife</cidade>
	<estado>PE</estado>
	<cep>50000000</cep>
	<email>joao@email.com</email>
	<telefone>999999999</telefone>
	<sexo>M</sexo>
	<cpf>10000000000</cpf>
	<cnpj/>
	<data_nascimento>08/08/1990 00:00:00</data_nascimento>
	<data_cadastro>27/07/2016 16:44:53</data_cadastro>
	<id_loja>1</id_loja>
	</item>
	</response>
</api>




FIND

MÉTODO find
DESCRIÇÃO Retorna um consumidor
PARAMETROS OBRIGATÓRIOS cod (Int) ou cpf (String) ou cnpj (String)
token
PARAMETROS OPCIONAIS
URL /api/consumidores/find
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
	<request>
	<module>api</module>
	<controller>consumidores</controller>
	<action>find</action>
	<cod>1</cod>
	<token>17c4520f64561ab53d8745e84681eb49194hkbnxi1241f278z</token>
	</request>
	<response>
	<error>0</error>
	<login>id_14</login>
	<id>1</id>
	<tipo>0</tipo>
	<nome>João da Silva</nome>
	<endereco>R. Salvador de Sá</endereco>
	<numero>2</numero>
	<complemento/>
	<bairro>Várzea</bairro>
	<cidade>Recife</cidade>
	<estado>PE</estado>
	<cep>50000000</cep>
	<email>joao@email.com</email>
	<telefone>999999999</telefone>
	<sexo>M</sexo>
	<cpf>10000000000</cpf>
	<cnpj/>
	<data_nascimento>08/08/1990 00:00:00</data_nascimento>
	<data_cadastro>27/07/2016 16:44:53</data_cadastro>
	<id_loja>1</id_loja>
	</response>
</api>




PROFILE

(Retorna detalhes do cliente - para usuário/cliente autenticado no sistema)
MÉTODO profile
DESCRIÇÃO Retorna um consumidor
PARAMETROS OBRIGATÓRIOS token
PARAMETROS OPCIONAIS resumido (0 ou 1)
URL /api/cadastros/profile
MÉTODO HTTP POST
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
	<request>
	<module>api</module>
	<controller>consumidores</controller>
	<action>profile</action>
	<token>7c48b84c642131f8a3ab76c4a7b98e7d49lu1234d9ao74tygc</token>
	</request>
	<response>
	<error>0</error>
	<login>id_14</login>
	<id>1</id>
	<tipo>0</tipo>
	<nome>João da Silva</nome>
	<endereco>R. Salvador de Sá</endereco>
	<numero>1</numero>
	<complemento/>
	<bairro>Várzea</bairro>
	<cidade>Recife</cidade>
	<estado>PE</estado>
	<cep>50000000</cep>
	<email>joao@email.com</email>
	<telefone>999999999</telefone>
	<sexo>M</sexo>
	<cpf>10000000000</cpf>
	<cnpj/>
	<data_nascimento>08/08/1990 00:00:00</data_nascimento>
	<data_cadastro>2016-07-27 16:44:53</data_cadastro>
	<id_loja>1</id_loja>
	<saldo_creditos>38882.4</saldo_creditos>
	</response>
</api>

Faturas (pedidos)

  1. - Método LIST
  2. - Método LISTOPL
  3. - Método FIND
  4. - Método UPDATE
  5. - Método UPDATEOPL
  6. - Método CONFIRM
  7. - Método CANCEL
  8. - Método GETITEMS




LIST

MÉTODO list
DESCRIÇÃO Retorna a lista de faturas
PARAMETROS OBRIGATÓRIOS token
PARAMETROS OPCIONAIS id_cadastro (Int)
data_ini (String - data no formato Pt-Br)
data_fim (String - data no formato Pt-Br)
status(
0=>Aguardando pagamento,
1=>Pago,
2=>Cancelado,
3=>Vencido
)

OBS.:
  • Os parametros de data são opcionais caso seja informado id_cadastro;
  • id_cadastro parametro disponível apenas para sistemas desenvolvidos a partir de Agosto de 2017.
URL /api/faturas/list
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
<request>
	<module>api</module>
	<controller>faturas</controller>
	<action>list</action>
	<token>17c4520f6cfd1ab53d8545e84681eb491ggjb6zvl518tcfd32</token>
</request>
<response>
	<error>0</error>
	<item>
	<id>280</id>
	<data_fatura>12/01/2017 16:44:13</data_fatura>
	<data_vencimento>15/01/2017 00:00:00</data_vencimento>
	<data_baixa/>
	<data_pagamento/>
	<tipo>Boleto Bancário</tipo>
	<confirmado>0</confirmado>
	<valor>200,00</valor>
	<valor_frete>0,00</valor_frete>
	<valor_desconto>0,00</valor_desconto>
	<valor_creditos>0,00</valor_creditos>
	<codigo/>
	<id_cdr/>
	<origem_baixa/>
	<data_cancelamento/>
	<id_cadastro_entrega/>
	<memo/>
	<status_entrega/>
	<codigo_rastreio/>
	<id_cadastro>1</id_cadastro>
	<id_consumidor>1</id_consumidor>
	<peso_total>0.2</peso_total>
	<tipo_envio/>
	<endereco>rua 1</endereco>
	<numero>3</numero>
	<complemento/>
	<bairro>Centro</bairro>
	<cidade>Recife</cidade>
	<estado>PE</estado>
	<cep>22222-222</cep>
	<destinatario>ID_1</destinatario>
	</item>
</response>
</api>




LISTOPL

MÉTODO listopl
DESCRIÇÃO Retorna a lista de faturas de um determinado operadora logístico
PARAMETROS OBRIGATÓRIOS data_ini (String - data no formato Pt-Br)
data_fim (String - data no formato Pt-Br)
token
PARAMETROS OPCIONAIS status_opl(
0=>Pendente,
1=>Enviado P/ OPL,
)
URL /api/faturas/listopl
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
	<request>
		<module>api</module>
		<controller>faturas</controller>
		<action>listopl</action>
		<token>8a86d60bff0d1712w18ec014bb549d893134xfaut3lnwqwehs</token>
	</request>
	<response>
		<error>0</error>
		<item>
			<pedido>
				<id>137</id>
				<data_pedido>24/01/2017 19:41:24</data_pedido>
			</pedido>
			<cadastro>
				<id>1</id>
				<tipo_cadastro>0</tipo_cadastro>
				<nome>JOãO DA SILVA</nome>
				<logradouro/>
				<endereco>Rua Paissandu</endereco>
				<numero>123</numero>
				<complemento/>
				<bairro>Centro</bairro>
				<cidade>Araguari</cidade>
				<estado>MG</estado>
				<cep>38440-224</cep>
				<email>suporte@mercadons.com.br</email>
				<email_alternativo/>
				<telefone_residencial>(11) 3333-3333</telefone_residencial>
				<telefone_celular>(11) 88888-8888</telefone_celular>
				<telefone_comercial/>
				<telefone_recados/>
				<operadora>Oi</operadora>
				<sexo>M</sexo>
				<cpf>787.531.442-69</cpf>
				<cnpj/>
				<inscricao_estadual/>
				<nome_empresa/>
				<rg>13.494.341-7</rg>
				<data_nascimento>1986-03-18 00:00:00</data_nascimento>
				<cod_banco>31</cod_banco>
				<agencia>1212</agencia>
				<tipo_conta>0</tipo_conta>
				<conta>213123321</conta>
				<nome_titular_conta>0</nome_titular_conta>
				<cpf_conta>0</cpf_conta>
				<operacao>0</operacao>
				<variacao>0</variacao>
				<data_cadastro>2015-07-29 17:12:50</data_cadastro>
				<indicante_id>0</indicante_id>
				<ativo>1</ativo>
				<data_ativacao>2017-01-23 19:13:59</data_ativacao>
				<pis_pasepe_nis/>
				<nacionalidade/>
				<endereco_entrega>
				<endereco>Rua Paissandu</endereco>
				<numero>123</numero>
				<complemento/>
				<bairro>Centro</bairro>
				<cidade>Araguari</cidade>
				<estado>MG</estado>
				<cep>38440-224</cep>
				</endereco_entrega>
			</cadastro>
			<produtos>
				<item>
					<id>255</id>
					<id_produto>3</id_produto>
					<quantidade>1</quantidade>
					<pontos>0</pontos>
					<valor>908.64</valor>
					<numero_serie/>
					<url_nota_fiscal/>
					<status_envio>0</status_envio>
					<modelo_terminal>a45b62-3</modelo_terminal>
					<iccid>87865168798</iccid>
					<data_inicio_garantia>12/10/2016</data_inicio_garantia>
					<data_fim_garantia>11/10/2017</data_fim_garantia>
				</item>
			</produtos>
		</item>
	</response>
</api>




FIND

MÉTODO find
DESCRIÇÃO Retorna a lista de faturas
PARAMETROS OBRIGATÓRIOS cod (Int) ou
documento (Int)
token
PARAMETROS OPCIONAIS
URL /api/faturas/find
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
<request>
	<module>api</module>
	<controller>faturas</controller>
	<action>find</action>
	<token>17c4520f6cfd1ab53d8745e85551eb491mgjb6zvl518fffds2</token>
	<cod>1</cod>
</request>
<response>
	<error>0</error>
	<id>1</id>
	<data_fatura>14/09/2015 18:08:10</data_fatura>
	<data_vencimento>15/09/2015 21:00:00</data_vencimento>
	<data_baixa>25/11/2015 21:00:00</data_baixa>
	<data_pagamento>25/11/2015 21:00:00</data_pagamento>
	<tipo>Boleto Bancário</tipo>
	<confirmado>1</confirmado>
	<valor>78,00</valor>
	<valor_frete>86,14</valor_frete>
	<valor_desconto>78,00</valor_desconto>
	<valor_creditos>0,00</valor_creditos>
	<codigo>1</codigo>
	<id_cdr>0</id_cdr>
	<origem_baixa>1</origem_baixa>
	<data_cancelamento>00/00/0000 00:00:00</data_cancelamento>
	<id_cadastro_entrega>0</id_cadastro_entrega>
	<memo>Compra na loja.</memo>
	<status_entrega>0</status_entrega>
	<codigo_rastreio/>
	<id_cadastro>1</id_cadastro>
	<id_consumidor>1</id_consumidor>
	<peso_total>2.2</peso_total>
	<tipo_envio>SEDEX</tipo_envio>
	<endereco>Rua Almir Azevedo</endereco>
	<numero>12</numero>
	<complemento/>
	<bairro>Várzea</bairro>
	<cidade>Recife</cidade>
	<estado>Pernambuco</estado>
	<cep>50740-610</cep>
	<destinatario>id_1</destinatario>
	<itens>
	<item>
		<id>1</id>
		<id_produto>8</id_produto>
		<nome_produto>Produto 05</nome_produto>
		<quantidade>12</quantidade>
		<valor_total>78,00</valor_total>
		<valor_unidade>13,00</valor_unidade>
		<codigo>maxx - 05</codigo>
		<sku/>
	</item>
	<item>
		<id>7</id>
		<id_produto>1</id_produto>
		<nome_produto>Adesão Basic</nome_produto>
		<quantidade>1</quantidade>
		<valor_total>99,00</valor_total>
		<valor_unidade>99,00</valor_unidade>
		<codigo/>
		<sku/>
	</item>
	</itens>
</response>
</api>




UPDATE

MÉTODO update
DESCRIÇÃO Atualiza status ou código de rastreio da fatura
PARAMETROS OBRIGATÓRIOS cod (Int)
token
status (int)
  • 0 => Preparando Pedido
  • 1 => Enviado
  • 2 => Entregue
PARAMETROS OPCIONAIS codigo_rastreio (String)
data_envio (String - formato Pt-Br) - Só no caso de status = 2 (Entregue)
URL /api/faturas/update
MÉTODO HTTP POST, PUT
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO




UPDATEOPL

MÉTODO updateopl
DESCRIÇÃO Atualiza produtos de uma determinada fatura
PARAMETROS OBRIGATÓRIOS cod (Int) - id do item
token
PARAMETROS OPCIONAIS codigo_rastreio (String)
url_nota_fiscal (String)
numero_serie (String)
modelo_terminal (String)
iccid (String)
data_inicio_garantia (String - formato Pt-Br)
data_fim_garantia (String - formato Pt-Br)
status_envio (int)
  • 0 => Preparando Pedido
  • 1 => Enviado
  • 2 => Entregue
URL /api/faturas/updateopl
MÉTODO HTTP POST, PUT
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO




CONFIRM

MÉTODO confirm
DESCRIÇÃO Confirma pagamento da fatura
PARAMETROS OBRIGATÓRIOS cod(Int)
valor (String - formato pt/br)
token
forma_pagamento (int)
  • 19 => Boleto
  • 31 => Transferência
  • 25 => Depósito
  • 26 => Depósito Bradesco
  • 27 => Depósito Itaú
  • 28 => Depósito CEF
  • 29 => Cartão de Crédito
  • 30 => Dinheiro
  • 31 => Créditos
PARAMETROS OPCIONAIS
  • obs (String)
  • data_pagamento(String - formato Pt-Br)
URL /api/faturas/confirm
MÉTODO HTTP POST, PUT
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO




CANCEL

MÉTODO cancel
DESCRIÇÃO Cancela a fatura
PARAMETROS OBRIGATÓRIOS cod(Int)
token
PARAMETROS OPCIONAIS
URL /api/faturas/cancel
MÉTODO HTTP POST, PUT
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO




GETITEMS

MÉTODO getitems
DESCRIÇÃO Retorna produtos da fatura
PARAMETROS OBRIGATÓRIOS cod(Int)
token
PARAMETROS OPCIONAIS
URL /api/faturas/getitems
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
	<request>
		<module>api</module>
		<controller>faturas</controller>
		<action>getitems</action>
		<token>17c4520f6cfd1se43d8745e84681eb491mgjb6zvl511e5fds2</token>
		<cod>1</cod>
	</request>
	<response>
		<error>0</error>
		<item>
			<id>1</id>
			<id_produto>8</id_produto>
			<nome_produto>Produto 05</nome_produto>
			<quantidade>12</quantidade>
			<valor_total>78,00</valor_total>
			<valor_unidade>13,00</valor_unidade>
			<codigo>maxx - 05</codigo>
			<sku/>
		</item>
		<item>
			<id>7</id>
			<id_produto>1</id_produto>
			<nome_produto>Adesão Basic</nome_produto>
			<quantidade>1</quantidade>
			<valor_total>99,00</valor_total>
			<valor_unidade>99,00</valor_unidade>
			<codigo/>
			<sku/>
		</item>
	</response>
</api>
DADOS
  • id_produto
  • nome_produto
  • quantidade
  • valor_total
  • valor_unidade
  • codigo
  • sku

Faturas (Compras do CDR)

  1. - Método LIST
  2. - Método FIND
  3. - Método GETITEMS




LIST

MÉTODO list
DESCRIÇÃO Retorna a lista de faturascdr
PARAMETROS OBRIGATÓRIOS token
PARAMETROS OPCIONAIS id_cadastro (Int)
data_ini (String - data no formato Pt-Br)
data_fim (String - data no formato Pt-Br)
status(
0=>Aguardando pagamento,
1=>Pago,
2=>Cancelado,
3=>Vencido
)

OBS.:
  • Os parametros de data são opcionais caso seja informado id_cadastro;
  • id_cadastro parametro disponível apenas para sistemas desenvolvidos a partir de Agosto de 2017.
URL /api/faturascdr/list
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
<request>
	<module>api</module>
	<controller>faturascdr</controller>
	<action>list</action>
	<token>17c4520f6cfd1ab53d8545e84681eb491ggjb6zvl518tcfd32</token>
</request>
<response>
	<error>0</error>
	<item>
	<id>280</id>
	<data_fatura>12/01/2017 16:44:13</data_fatura>
	<data_vencimento>15/01/2017 00:00:00</data_vencimento>
	<data_baixa/>
	<data_pagamento/>
	<tipo>Boleto Bancário</tipo>
	<confirmado>0</confirmado>
	<valor>200,00</valor>
	<valor_frete>0,00</valor_frete>
	<valor_creditos>0,00</valor_creditos>
	<codigo/>
	<id_cdr/>
	<origem_baixa/>
	<data_cancelamento/>
	<id_cadastro_entrega/>
	<memo/>
	<status_entrega/>
	<codigo_rastreio/>
	<id_cadastro>1</id_cadastro>
	<id_consumidor>1</id_consumidor>
	<peso_total>0.2</peso_total>
	<tipo_envio/>
	<endereco>rua 1</endereco>
	<numero>3</numero>
	<complemento/>
	<bairro>Centro</bairro>
	<cidade>Recife</cidade>
	<estado>PE</estado>
	<cep>22222-222</cep>
	<destinatario>ID_1</destinatario>
	</item>
</response>
</api>




FIND

MÉTODO find
DESCRIÇÃO Retorna a lista de faturascdr
PARAMETROS OBRIGATÓRIOS cod (Int) ou
documento (Int)
token
PARAMETROS OPCIONAIS
URL /api/faturascdr/find
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
<request>
	<module>api</module>
	<controller>faturascdr</controller>
	<action>find</action>
	<token>17c4520f6cfd1ab53d8745e85551eb491mgjb6zvl518fffds2</token>
	<cod>1</cod>
</request>
<response>
	<error>0</error>
	<id>1</id>
	<data_fatura>14/09/2015 18:08:10</data_fatura>
	<data_vencimento>15/09/2015 21:00:00</data_vencimento>
	<data_baixa>25/11/2015 21:00:00</data_baixa>
	<data_pagamento>25/11/2015 21:00:00</data_pagamento>
	<tipo>Boleto Bancário</tipo>
	<confirmado>1</confirmado>
	<valor>78,00</valor>
	<valor_frete>86,14</valor_frete>
	<valor_creditos>0,00</valor_creditos>
	<codigo>1</codigo>
	<id_cdr>0</id_cdr>
	<origem_baixa>1</origem_baixa>
	<data_cancelamento>00/00/0000 00:00:00</data_cancelamento>
	<id_cadastro_entrega>0</id_cadastro_entrega>
	<memo>Compra na loja.</memo>
	<status_entrega>0</status_entrega>
	<codigo_rastreio/>
	<id_cadastro>1</id_cadastro>
	<id_consumidor>1</id_consumidor>
	<peso_total>2.2</peso_total>
	<tipo_envio>SEDEX</tipo_envio>
	<endereco>Rua Almir Azevedo</endereco>
	<numero>12</numero>
	<complemento/>
	<bairro>Várzea</bairro>
	<cidade>Recife</cidade>
	<estado>Pernambuco</estado>
	<cep>50740-610</cep>
	<destinatario>id_1</destinatario>
	<itens>
	<item>
		<id>1</id>
		<id_produto>8</id_produto>
		<nome_produto>Produto 05</nome_produto>
		<quantidade>12</quantidade>
		<valor_total>78,00</valor_total>
		<valor_unidade>13,00</valor_unidade>
		<codigo>maxx - 05</codigo>
		<sku/>
	</item>
	<item>
		<id>7</id>
		<id_produto>1</id_produto>
		<nome_produto>Adesão Basic</nome_produto>
		<quantidade>1</quantidade>
		<valor_total>99,00</valor_total>
		<valor_unidade>99,00</valor_unidade>
		<codigo/>
		<sku/>
	</item>
	</itens>
</response>
</api>




GETITEMS

MÉTODO getitems
DESCRIÇÃO Retorna produtos da fatura
PARAMETROS OBRIGATÓRIOS cod(Int)
token
PARAMETROS OPCIONAIS
URL /api/faturascdr/getitems
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
	<request>
		<module>api</module>
		<controller>faturascdr</controller>
		<action>getitems</action>
		<token>17c4520f6cfd1se43d8745e84681eb491mgjb6zvl511e5fds2</token>
		<cod>1</cod>
	</request>
	<response>
		<error>0</error>
		<item>
			<id>1</id>
			<id_produto>8</id_produto>
			<nome_produto>Produto 05</nome_produto>
			<quantidade>12</quantidade>
			<valor_total>78,00</valor_total>
			<valor_unidade>13,00</valor_unidade>
			<codigo>maxx - 05</codigo>
			<sku/>
		</item>
		<item>
			<id>7</id>
			<id_produto>1</id_produto>
			<nome_produto>Adesão Basic</nome_produto>
			<quantidade>1</quantidade>
			<valor_total>99,00</valor_total>
			<valor_unidade>99,00</valor_unidade>
			<codigo/>
			<sku/>
		</item>
	</response>
</api>
DADOS
  • id_produto
  • nome_produto
  • quantidade
  • valor_total
  • valor_unidade
  • codigo
  • sku

Produtos

  1. - Método LIST
  2. - Método FIND
  3. - Método INSERT
  4. - Método UPDATE




LIST

MÉTODO list
DESCRIÇÃO Retorna a lista de produtos
PARAMETROS OBRIGATÓRIOS token
PARAMETROS OPCIONAIS categoria (String - nome da categoria)
id_categoria (int - id da categoria)
nome (String - nome do produto)
kit (int - [0 ou 1])
URL /api/produtos/list
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
	<request>
	<module>api</module>
	<controller>produtos</controller>
	<action>list</action>
	<token>17c4520f6cfd112e4d8745e84681eb491mgjb6zvl518t1ses2</token>
	</request>
	<response>
		<error>0</error>
		<item>
			<id>23</id>
			<id_categoria>1</id_categoria>
			<categoria>2Planos de Adesão</categoria>
			<nome>2</nome>
			<descricao><p>2</p></descricao>
			<peso>0,00</peso>
			<pontos>2,00</pontos>
			<valor>0,02</valor>
			<ativo>sim</ativo>
			<codigo>2</codigo>
			<kit>não</kit>
			<especificacoes/>
			<endereco_loja>
			http://maxx/shopping/produtos/detalhesproduto/id/23
			</endereco_loja>
			<endereco_imagem/>
			<endereco_categoria>http://maxx.local/shopping/produtos/index/idc/1</endereco_categoria>
		</item>
		<item>
			<id>22</id>
			<id_categoria>1</id_categoria>
			<categoria>2Planos de Adesão</categoria>
			<nome>321</nome>
			<descricao><p>321</p></descricao>
			<peso>0,32</peso>
			<pontos>321,00</pontos>
			<valor>0,00</valor>
			<ativo>sim</ativo>
			<codigo/>
			<kit>não</kit>
			<especificacoes/>
			<endereco_loja>
			http://maxx/shopping/produtos/detalhesproduto/id/22
			</endereco_loja>
			<endereco_imagem/>
			<endereco_categoria>http://maxx.local/shopping/produtos/index/idc/1</endereco_categoria>
		</item>
	</response>
</api>




FIND

MÉTODO find
DESCRIÇÃO Retorna um produto
PARAMETROS OBRIGATÓRIOS cod(int - id do produto)
token
URL /api/produtos/find
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
    <api>
	<request>
		<module>api</module>
		<controller>produtos</controller>
		<action>find</action>
		<token>17c4520f6cf1srf53d8745e84681eb491mgjb6zvl518tc2ds2</token>
		<cod>10</cod>
	</request>
	<response>
		<error>0</error>
		<id>10</id>
		<id_categoria>2</id_categoria>
		<categoria>Planos</categoria>
		<nome>Produto 07</nome>
		<descricao>Nulla Facilisi. Duis Aliquet Egestas Purus In Lorem ipsum dolor sit amet.</descricao>
		<peso>0,10</peso>
		<pontos>100,00</pontos>
		<valor>14,00</valor>
		<ativo>sim</ativo>
		<codigo>maxx - 07</codigo>
		<kit>não</kit>
		<especificacoes/>
		<endereco_loja>
		http://maxx/shopping/produtos/detalhesproduto/id/10
		</endereco_loja>
		<endereco_imagem/>
		<endereco_categoria>http://maxx/shopping/produtos/index/idc/2</endereco_categoria>
	</response>
</api>




INSERT

MÉTODO insert
DESCRIÇÃO Insere um produto
PARAMETROS OBRIGATÓRIOS nome(String)
descricao(String)
token
PARAMETROS OPCIONAIS id_categoria(int)
peso(String)
sku(String)
pontos(String - 0.00)
valor(String - 0.00)
ativo(1|0)
codigo(String)
quantidade_estoque(int)
imagens(array base64)
URL /api/produtos/insert
MÉTODO HTTP POST
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
    <api>
	<request>
		<module>api</module>
		<controller>produtos</controller>
		<action>insert</action>
		<token>17c4520f6cf1srf53d8745e84681eb491mgjb6zvl518tc2ds2</token>
		<nome>Produto 1</nome>
		<descricao>Descrição Produto 1</descricao>
		<descricao>Nulla Facilisi. Duis Aliquet Egestas Purus In Lorem ipsum dolor sit amet.</descricao>
	</request>
  <response>
    <error>0</error>
    <erro>0</erro>
    <msg>Salvo com sucesso.</msg>
  </response>
</api>




UPDATE

MÉTODO update
DESCRIÇÃO Atualiza um produto
PARAMETROS OBRIGATÓRIOS cod(int)
descricao(String)
token
PARAMETROS OPCIONAIS id_categoria(int)
peso(String)
sku(String)
pontos(String - 0.00)
valor(String - 0.00)
ativo(1|0)
codigo(String)
quantidade_estoque(int)
imagens(array base64)
URL /api/produtos/update
MÉTODO HTTP POST
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
    <api>
	<request>
		<module>api</module>
		<controller>produtos</controller>
		<action>insert</action>
		<token>17c4520f6cf1srf53d8745e84681eb491mgjb6zvl518tc2ds2</token>
		<nome>Produto 1</nome>
		<descricao>Nulla Facilisi. Duis Aliquet Egestas Purus In Lorem ipsum dolor sit amet.</descricao>
	</request>
  <response>
    <error>0</error>
    <erro>0</erro>
    <msg>Salvo com sucesso.</msg>
  </response>
</api>

Categorias

  1. - Método LIST
  2. - Método FIND




LIST

MÉTODO list
DESCRIÇÃO Retorna a lista de categorias
PARAMETROS OBRIGATÓRIOS token
PARAMETROS OPCIONAIS nome (String - nome da categoria)
ativo (int - [0 ou 1])
URL /api/categorias/list
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
<request>
	<module>api</module>
	<controller>categorias</controller>
	<action>list</action>
	<token>17c4520f6cfd1ab53d1we4e84681eb491mgjb6zvl1wr4cfds2</token>
</request>
<response>
	<error>0</error>
	<item>
		<id>6</id>
		<categoria>Categoria 05</categoria>
		<ativo>1</ativo>
		<id_categoria_pai>0</id_categoria_pai>
		<categoria_pai/>
		<endereco_categoria>http://maxx/shopping/produtos/index/idc/6</endereco_categoria>
	</item>
	<item>
		<id>5</id>
		<categoria>Categoria 04</categoria>
		<ativo>1</ativo>
		<id_categoria_pai>4</id_categoria_pai>
		<categoria_pai>Categoria 03</categoria_pai>
		<endereco_categoria>http://maxx/shopping/produtos/index/idc/5</endereco_categoria>
	</item>
</response>
</api>




FIND

MÉTODO find
DESCRIÇÃO Retorna a lista de categorias
PARAMETROS OBRIGATÓRIOS id(int - id da categoria)
token
URL /api/categorias/find
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
	<request>
		<module>api</module>
		<controller>categorias</controller>
		<action>find</action>
		<token>17c4520f6c1wr4b53d8745e84681eb491mgjb6zvl518t1w4s2</token>
		<cod>1</cod>
	</request>
	<response>
		<error>0</error>
		<id>1</id>
		<categoria>2Planos de Adesão</categoria>
		<ativo>1</ativo>
		<id_categoria_pai>0</id_categoria_pai>
		<categoria_pai/>
		<endereco_categoria>http://maxx/shopping/produtos/index/idc/1</endereco_categoria>
	</response>
</api>

CRÉDITOS

  1. - Método LIST
  2. - Método CONFIRM
  3. - Método REJECT
  4. - Método GETBALANCE
  5. - Método GETBALANCEBYID




LIST

MÉTODO list
DESCRIÇÃO Retorna a lista de créditos
PARAMETROS OBRIGATÓRIOS ano (Int)
token
PARAMETROS OPCIONAIS mes(Int)
situacao(
0 => aberta,
1 => confirmada,
2 => recusada
)
URL /api/creditos/list
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
	<request>
		<module>api</module>
		<controller>creditos</controller>
		<action>list</action>
		<token>17c4520f6cfd1qwe3d8745e84681eb491mgjb6zvl518tasdf2</token>
		<debug>1</debug>
		<ano>2016</ano>
	</request>
	<response>
		<error>0</error>
		<item>
			<id>37</id>
			<id_cadastro>130</id_cadastro>
			<valor_solicitado>115</valor_solicitado>
			<data_solicitacao>29/09/2016 17:10:28</data_solicitacao>
			<tipo_solicitacao>0</tipo_solicitacao>
			<data_baixa/>
			<log/>
			<recusado/>
			<data_recusa/>
			<valor>115,00</valor>
			<tipo_cadastro>1</tipo_cadastro>
			<numero_documento>75622106320</numero_documento>
			<nome_favorecido>343445</nome_favorecido>
			<nome_empresa/>
			<cnpj/>
			<codigo_banco_favorecido>1</codigo_banco_favorecido>
			<conta_favorecido>353353</conta_favorecido>
			<dv_conta_favorecido>0</dv_conta_favorecido>
			<agencia_favorecido>3243</agencia_favorecido>
			<dv_agencia_favorecido>0</dv_agencia_favorecido>
			<bairro>Espinheiro</bairro>
			<cep>52021-220</cep>
			<cidade>Recife</cidade>
			<estado>PE</estado>
			<complemento/>
			<tipo_conta>0</tipo_conta>
			<cpf_conta>0</cpf_conta>
		</item>
		<item>
			<id>36</id>
			<id_cadastro>130</id_cadastro>
			<valor_solicitado>115</valor_solicitado>
			<data_solicitacao>29/09/2016 17:05:39</data_solicitacao>
			<tipo_solicitacao>0</tipo_solicitacao>
			<data_baixa/>
			<log/>
			<recusado/>
			<data_recusa/>
			<valor>115,00</valor>
			<tipo_cadastro>1</tipo_cadastro>
			<numero_documento>75622106320</numero_documento>
			<nome_favorecido>343445</nome_favorecido>
			<nome_empresa/>
			<cnpj/>
			<codigo_banco_favorecido>1</codigo_banco_favorecido>
			<conta_favorecido>353353</conta_favorecido>
			<dv_conta_favorecido>0</dv_conta_favorecido>
			<agencia_favorecido>3243</agencia_favorecido>
			<dv_agencia_favorecido>0</dv_agencia_favorecido>
			<bairro>Espinheiro</bairro>
			<cep>52021-220</cep>
			<cidade>Recife</cidade>
			<estado>PE</estado>
			<complemento/>
			<tipo_conta>0</tipo_conta>
			<cpf_conta>0</cpf_conta>
		</item>
	</response>
</api>




CONFIRM

MÉTODO confirm
DESCRIÇÃO Confirma um determinado crédito
PARAMETROS OBRIGATÓRIOS cod (Int)
Valor (String - formato pt/br)
cod_cliente (Int) ou cpf_cliente (String) ou cnpj_cliente (String)
token
PARAMETROS OPCIONAIS
URL /api/creditos/confirm
MÉTODO HTTP POST, PUT
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO




REJECT

MÉTODO reject
DESCRIÇÃO Recusa um determinado crédito
PARAMETROS OBRIGATÓRIOS cod (Int)
Valor (String - formato pt/br)
cod_cliente (Int) ou cpf_cliente (String) ou cnpj_cliente (String)
token
PARAMETROS OPCIONAIS
URL /api/creditos/reject
MÉTODO HTTP POST, PUT
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO




GETBALANCE

MÉTODO getbalance
DESCRIÇÃO Retorna a saldo de créditos de um determinado cadastro
PARAMETROS OBRIGATÓRIOS cod (Int)
token
PARAMETROS OPCIONAIS
URL /api/creditos/getbalance
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
	<request>
	<module>api</module>
	<controller>creditos</controller>
	<action>getbalance</action>
	<token>17c4520f6cfd1ab53d8745e84681eb491r9xhm6k1pwf58zg4n</token>
	<cod>1</cod>
	</request>
	<response>
	<error>0</error>
	<nao_sacavel>35.156,00</nao_sacavel>
	<sacavel>0,00</sacavel>
	</response>
</api>




GETBALANCEBYID

MÉTODO getbalancebyid
DESCRIÇÃO Retorna a saldo de créditos do cadastro logado
PARAMETROS OBRIGATÓRIOS token
PARAMETROS OPCIONAIS
URL /api/creditos/getbalancebyid
MÉTODO HTTP GET
ERROS
  • 0 => Erro do sistema
  • 1 => Usuário não encontrado
  • 2 => Parâmetros Incorretos
  • 3 => Dados não encontrados
  • 4 => Sessão Expirada
  • 5 => Token Inválido
  • 6 => Método HTTP Incorreto
RETORNO XML
EXEMPLO DE RETORNO 
<api>
	<request>
	<module>api</module>
	<controller>creditos</controller>
	<action>getbalancebyid</action>
	<token>17c4520f6cfd1ab53d8745e84681eb491r9xhm6k1pwf58zg4n</token>
	<cod>1</cod>
	</request>
	<response>
	<error>0</error>
	<nao_sacavel>35.156,00</nao_sacavel>
	<sacavel>0,00</sacavel>
	</response>
</api>

Obrigado!

A Mercado:NS agradece a parceiria.

Se você tiver algum problema por favor abrir um chamado em http://suporte.mercadons.com.br/.

http://maxxmultinivel.com.br