MANUAL DE
INTEGRAÇÃO - API
Conteúdo
API Compre & Confie
Implementação
Exemplo de envio de transação
Developer
Swagger
Parâmetros
A
API
é responsável pela captação dos dados quantitativos no checkout de cada loja participante do
Movimento
Compre & Confie
, recebendo informações transacionais das vendas dos produtos em tempo real.
É imprescindível a aplicação correta da API com os devidos parâmetros preenchidos no checkout da loja, sem a troca
de dados
não
é possível gerar insumos para o relatório.
Na página de checkout, deve-se utilizar a URL API Homologação, e informar a sua apiKey, que é fornecida pelo nosso
canal de atendimento. Siga o passo a passo de preenchimento de todos os parâmetros, não se esquecendo do
orderSellerID
. A seguir há uma exemplificação de envio de uma transação através da API.
*A validação das requisições em ambiente de homologação é feita com o time de integração através do e-mail comercial@compreconfie.com.br
URL API Homologação
https://sellerapiqa.compreconfie.com.br/sale?
apiKey
=
apiKey
Exemplo de envio de uma transação
O método abaixo é uma exemplificação em C# de envio de uma transação através da API. O envio correto retornará OK
(HttpStatusCode)
Implementação
URL API Produção
https://sellerapiqa.compreconfie.com.br/sale?apiKey=apiKey
*A apiKey é fornecida pelo atendimento. Contatos no final do manual.
Na página de checkout, deve-se utilizar a URL API, e informar a sua apiKey, que é fornecida pelo nosso canal de
atendimento. Siga o passo a passo de preenchimento de todos os parâmetros, não se esquecendo do orderSellerID.
A validação da parametrização pode ser feita em nosso site, na página de
Developer
.
Developer
Validação da Parametrização
Após a implementação em produção, é possível validar a integração através do site, na aba Developer. Basta inserir o
SellerId e o ID da transação (número do pedido) feito nas últimas 4 horas.
X - Parâmetro Incorreto
? - Parâmetro nulo
- Parâmetro correto
API Compre & Confie
Swagger
O JSON pode ser visualizado pelo Swagger via url abaixo
Produção -
https://sellerapi.compreconfie.com.br/swagger
Homologação -
https://sellerapiqa.compreconfie.com.br/swagger
Os Parâmetros, como detalhado a seguir, devem ser correspondentes aos da sua plataforma de e-commerce (pode variar
de acordo com a plataforma ou desenvolvedor).
Importante:
Uma transação pode ter mais de um item de compra. Por exemplo: smartphone e console de videogame.
Os campos do tipo Product (productName, productValue, productQuantity...) devem conter todos os itens preenchidos
e separados por | (PIPE) respectivamente. Isso vale para formas de pagamento (orderPaymentType), em caso de
pedidos pagos com dois cartões.
Parâmetros do Pedido
A implementação da API com os parâmetros corretos é essencial para que o Compre & Confie possa receber todos os
atributos da compra em seu site e envie o relatório com os indicadores de mercado online.
Atributo Type Formato Descrição
billingCPF String 0
CPF obrigatório 11 dígitos sem pontos e dígitos separadores no formato 00000000000 billingEmail String usuario@dominio.com E-mail do consumidor
billingGender String M Enviar 'M' para Masculino e 'F' para Feminino
billingName String Nome Completo Nome completo do consumidor
billingPhone String 5511922222222 Telefone do Consumidor no formato DDI+DDD+Telefone billingZipcode String 00000000 Cep de entrega sem
separadores. consumerBirth
Date Date dd/MM/yyyy
Data de nascimento do consumidor
consumerCPF String 00000000000 CPF obrigatório 11 dígitos sem pontos e dígitos separadores.
Atributo Type Formato Descrição
consumerEmail String usuario@dominio.com E-mail do consumidor
consumerGender String F Enviar 'M' para Masculino e 'F' para Feminino
consumerName String Nome Completo Nome completo do consumidor consumerPhone String 5511922222222 Telefone do Consumidor no
formato DDI+DDD+Telefone consumerZipcode String 00000000 Cep do consumidor sem
separadores 00000000
orderBankEmissor String
ID Enviar neste campo o banco o id do emissor.
0 Bradesco
1 Itaú
2 Banco do Brasil
Parâmetros do Pedido
A implementação da API com os parâmetros corretos é essencial para que o Compre & Confie possa receber todos os
atributos da compra em seu site e envie o relatório com os indicadores de mercado online.
Atributo Type Formato Descrição
orderBankEmissor String 4 Santander 5 Credicard 6 BMG 7 Paraná Banco 8 Cetelem 9 Banco Original 10 Nubank 11 Banco Safra 12 Banco Votorantim 13 Banrisul 14 Banco Inter 15 Banco PAN 16 Outros
Atributo Type Formato Descrição
orderCardFlag String
ID
Enviar neste campo o ID da Bandeira do cartão usado na compra. 1 Diners Club 2 MasterCard 3 VISA 4 Outros 5 American Express 6 HiperCard 7 Aura 8 Elo 9 Cartão Mais
orderDate String yyyy-MM-ddhh:mm:ss Data do pedido orderDeliveryTax Float 0000.00 Valor do frete
Parâmetros do Pedido
A implementação da API com os parâmetros corretos é essencial para que o Compre & Confie possa receber todos os
atributos da compra em seu site e envie o relatório com os indicadores de mercado online.
Atributo Type Formato Descrição
orderDeliveryTime Date yyyy-MM-dd Data estimada da entrega.
orderDeliveryType String
ID
Neste campo Enviar o ID ao lado par cada tipo de entrega descrita a baixo. 0 Padrão 1 Expressa/Rápida 2 Agendada 3 Retirada Loja 4 Outros
orderID String Não tem um
formato definido Id do Pedido.
orderParcels Int 1
Quantidade de parcelas sendo 1 = à vista, 2 (pedido parcelado em 2x), 3 (pedido parcelado em 3x), 12 (pedido parcelado em 12x). 0 não é um valor válido
Atributo Type Formato Descrição
orderPartnerPayment Int
ID
Neste campo enviar o ID de acordo com o Parceiro de Pagmento 0 Visa Checkout 1 Mercado Pago 2 Paypal 3 Rede Pay 4 Pagseguro 5 Masterpass 6 Koin 7 Pagar.me 8 Wirecard 9 Onebuy 10 PayU
Parâmetros do Pedido
A implementação da API com os parâmetros corretos é essencial para que o Compre & Confie possa receber todos os
atributos da compra em seu site e envie o relatório com os indicadores de mercado online.
Atributo Type Formato Descrição
orderPartnerPayment Int 11 Stelo 12 Yapay 13 EBANX 14 getnet 15 Rede Pay 16 Cielo 17 Outros orderPaymentType Int ID
Enviar o ID de acordo com o Tipo de Pagamento 1 Cartão de Crédito 2 Boleto Bancário
3 Outros
4 Cartão da Loja
5 Pagamento por Celular
Atributo Type Formato Descrição
orderPaymentType Int
6 Transferência Bancária
7 Cupom
8 Cartão Presente/Vale
9 Cartão de Débito/Débito em Conta
orderPlatform Int
ID Enviaro o id de acordo com o dispositivo usado pelo comprador
0 Desktop
1 Mobile
2 App
orderSellerID String 000000 Id da loja no Compre & Confie
orderTotalSpent Float
0000.00
Valor total da transação sem separador de milhar e usando . (ponto final) como separador de centavos
productDeliveryTax Float 0000.00
Valor do frete sem separador de milhar e usando . (ponto final) como separador de centavos
Parâmetros do Pedido
A implementação da API com os parâmetros corretos é essencial para que o Compre & Confie possa receber todos os
atributos da compra em seu site e envie o relatório com os indicadores de mercado online.
Atributo Type Formato Descrição
productDeliveryTime Data dd/MM/yyyy Data estimada da entrega.
productDeliveryType Int
ID Enviar o id de acordo com o Tipo de entrega 0 Padrão 1 Expressa/Rápida 2 Agendada 3 Retirada Loja 4 Outros productDiscount Float 0000.00
Valor de desconto sem separador de milhar e usando . (ponto final) como separador de centavos
productEAN String Não tem um
formato definido Código EAN do produto
Atributo Type Formato Descrição
productMktSaleID String 99999999999999
Enviar apenas 0 se não for Marketplace e se for Marketplace informar o cnpj do
Marketplace sem nenhum separador
productName String (ASCII Para URLs) Não tem um formato definido
Nome do Produto. Se Na compra tiver mais de um protudo separar os nomes por | (PIPE). Ex.: TV LED 42 Polegadas | Ultrabook 8 GB RAM
productQuantity Int 1
Quantidade de item por produto. Caso seja uma lista, concatenar com | (PIPE)
Ex.: Uma compra com duas camisetas e uma calça enviar productQuantity : 2|1
productSKU
String (ASCII Para
URLs)
Não tem um
formato definido SKU do produto
productValue Float 0000.00
Informar o valor unitário do item da transação sem separação de milhar e com separação de centavos usando . (ponto). Caso seja uma lista concatenar com | (PIPE). Ex.: 10.00|99.55
