Português

A empresa permite a integração a sistemas externos, tais como ERPs, CRMs e sites empresariais. Podendo oferecer consultoria a sua solução.

Consulte nossa divisão de projetos especiais e compartilhe de nossa expertise para o desenvolvimento de soluções “sob-medida” para a sua campanha de incentivo, premiação ou promoção.
Atuamos com foco exclusivo em cartões presente, ingressos e vouchers, atendendo nossos clientes corporativos com soluções completas, desde o fornecimento dos cartões em pedidos pontuais ou “sob-demanda” com processamento operacional e a gestão logística total “door-to-door” em território nacional.

Antes de iniciar a integração, será necessário entrar em contato com a equipe da Incentivale para solicitar o usuário e senha além do token da campanha.

Precisa de um Help? Segue o projeto em POSTMAN :)

Abrir Collection Documentação

Requisição por HTTP com resposta em REST

Autenticação - Requisição do Access Token

POST: /oauth/token

Parâmetros:

grant_type: necessário informar "password".

username: usuário de autenticação.

password: senha de autenticação.

Requisito: Esse parâmetro deve ser enviado como "Content-Type: application/x-www-form-urlencoded"

Exemplo de resposta:

{
    "access_token": "MU_mz1OelXdFQ4azFQx0-xAd4gM5RXaA4udbuXTEkigg_CENDCbwFgwJQZPxU434a1OEmUmeVhDBFRFc6UpGhjlXRs3a_1WT2STHVZnmHecg3U60fz",
    "token_type": "bearer",
    "expires_in": 3599,
    "userName": "eduardo@v3api.com.br",
    ".issued": "Thu, 12 May 2016 02:35:13 GMT",
    ".expires": "Thu, 12 May 2016 03:35:13 GMT"
}

O tempo de validade do token são de 60 minutos.

Buscar produtos do catálogo

GET: /api/v3/products?token=xxxxxxx

Parâmetros:

Token: Identificação da campanha.

Serviço resposável em identificar os produtos do catálogo, negociado anteriormente junto ao comercial da Incentivale. Todos os produtos são identificados pelo SKU.

Exemplo de requisição:

GET  /api/v3/products?token=a17b1c6358454dfeb5fa3fa0d3d592a1 HTTP/1.1
Authorization: Bearer MU_mz1OelXdFQ4azFQx0-xAd4gM5RXaA4udbuXTEkigg_CENDCbwFgwJQZPxU434a1OEmUmeVhDBFRFc6UpGhjlXRs3a_1WT2STHVZnmHecg3U60fz

Exemplo de resposta:

{  
   "Success":true,
   "MessageReturn":"Sucesso",
   "Products":[  
      {  
         "SKU":"CPFBR061V100",
         "IsFreeRange":false,
         "IsVirtual":false,
         "IsDownloadable":false,
         "ParentRechargeProduct" :"" ; 
         "PriceUN":"100,00",
         "RateADM":"0,00",
         "Freight":"15,00",
         "Handling":"2,00",
         "PriceTotal":"117,00",
         "Name":"CARTÃO PRESENTE RI HAPPY",
         "Description":"A Ri Happy traz para você o Happy Vale! Com ele, você pode escolher o que quiser em qualquer uma das lojas Ri Happy no Brasil!",
         "Enable":true,
         "LinkImageSmall": "https://central.incentivale.com.br/StorangeFiles/4a84984514ba49c49f7d749df3923213/d2e023a4fddb410890e1e67c06951a43.png",
         "LinkImageMedium":"https://central.incentivale.com.br/StorangeFiles/4a84984514ba49c49f7d749df3923213/d277663cec704e7aa0b2f6300f2f1acc.png",
         "LinkImageLarge": "https://central.incentivale.com.br/StorangeFiles/4a84984514ba49c49f7d749df3923213/030e2e82331e48f999ce5cafea342a0c.png",
         "CategoryId":17,
         "Category":"BRINQUEDOS"
      },
      {  
         "SKU":"CPFBR061V50",
         "IsFreeRange":false,
         "IsVirtual":false,
         "IsDownloadable":false,
         "ParentRechargeProduct" :"" ; 
         "PriceUN":"50,00",
         "RateADM":"0,00",
         "Freight":"15,00",
         "Handling":"2,00",
         "PriceTotal":"67,00",
         "Name":"CARTÃO PRESENTE RI HAPPY",
         "Description":"A Ri Happy traz para você o Happy Vale! Com ele, você pode escolher o que quiser em qualquer uma das lojas Ri Happy no Brasil!",
         "Enable":true,
         "LinkImageSmall": "https://central.incentivale.com.br/StorangeFiles/4a84984514ba49c49f7d749df3923213/d2e023a4fddb410890e1e67c06951a43.png",
         "LinkImageMedium":"https://central.incentivale.com.br/StorangeFiles/4a84984514ba49c49f7d749df3923213/d277663cec704e7aa0b2f6300f2f1acc.png",
         "LinkImageLarge": "https://central.incentivale.com.br/StorangeFiles/4a84984514ba49c49f7d749df3923213/030e2e82331e48f999ce5cafea342a0c.png",
         "CategoryId":17,
         "Category":"BRINQUEDOS"
      },
      {  
         "SKU":"CPFRE004V100",
         "IsFreeRange":false,
         "IsVirtual":false,
         "IsDownloadable":false,
         "ParentRechargeProduct" :"" ; 
         "PriceUN":"100,00",
         "RateADM":"0,00",
         "Freight":"15,00",
         "Handling":"2,00",
         "PriceTotal":"117,00",
         "Name":"CARTÃO PRESENTE APPLEBEES",
         "Description":"Escolha agora o seu cartão presente Applebee’s e conheça as especialidades e delícias que este variado menu traz para temperar o seu paladar.",
         "Enable":true,
         "LinkImageSmall": "https://central.incentivale.com.br/StorangeFiles/4a84984514ba49c49f7d749df3923213/d2e023a4fddb410890e1e67c06951a43.png",
         "LinkImageMedium":"https://central.incentivale.com.br/StorangeFiles/4a84984514ba49c49f7d749df3923213/d277663cec704e7aa0b2f6300f2f1acc.png",
         "LinkImageLarge": "https://central.incentivale.com.br/StorangeFiles/4a84984514ba49c49f7d749df3923213/030e2e82331e48f999ce5cafea342a0c.png",
         "CategoryId":8,
         "Category":"RESTAURANTES"
      }
   ]
}

Dados da resposta

NOME DA COLUNA	TIPO	INFORMAÇÃO
Success	BOLEANO	TRUE - SUCESSO FALSE - ERROR
MessageReturn	ALFANUMÉRICO	INFORMAÇÃO EM DESCRIÇÃO
Products	LISTA	PRODUTOS
SKU	ALFANUMÉRICO	IDENTIFICADOR(SKU) DO CATÁLOGO
IsFreeRange	BOLEANO	PRODUTO FAIXA LIVRE
IsVirtual	BOLEANO	PRODUTO VIRTUAL
IsDownloadable	BOLEANO	PRODUTO RECARREGÁVEL
ParentRechargeProduct	BOLEANO	PRODUTO RECARREGÁVEL - PRODUTO PAI
PriceUN	VALOR	VALOR UNITÁRIO
RateADM	VALOR	TAXA ADMINISTRATIVA
Freight	VALOR	VALOR DE FRETE
Handling	VALOR	VALOR DE MANUSEIO
PriceTotal	VALOR	VALOR TOTAL
Name	ALFANUMÉRICO	NOME DO PRODUTO
Description	ALFANUMÉRICO	DESCRIÇÃO DO PRODUTO - REGULAMENTO
Enable	BOLEANO	PRODUTO ATIVO
LinkImageSmall	ALFANUMÉRICO	LINK - IMAGEM PEQUENA
LinkImageMedium	ALFANUMÉRICO	LINK - IMAGEM MÉDIA
LinkImageLarge	ALFANUMÉRICO	LINK - IMAGEM GRANDE
CategoryId	NÚMERO	IDENTIFICADOR CATEGORIA
Category	ALFANUMÉRICO	DESCRIÇÃO DA CATEGORIA

Enviar pedido

POST: /api/v3/addresquest

Requisito: Esse parâmetro deve ser enviado como "Content-Type: application/x-www-form-urlencoded"

Cartão físico, cartão virtual, recarga de celular e pague contas.

NOME DA COLUNA	TIPO	LIMITE	FORMATO	OBRIGATÓRIO	INFORMAÇÃO
Token	ALFANUMÉRICO	***			IDENTIFICAÇÃO DA CAMPANHA
CodRequest	NÚMERO	***			CONTROLE DO CLIENTE
SKU	ALFANUMÉRICO	***			IDENTIFICADOR(SKU) DO CATÁLOGO
Name	ALFANUMÉRICO	200 CARACTERES			NOME DO BENEFICIÁRIO
CPF_CNPJ	ALFANUMÉRICO	30 CARACTERES			IDENTIFICAÇÃO - CPF OU CNPJ
Email	ALFANUMÉRICO	100 CARACTERES			E-MAIL DO BENEFICIÁRIO
Address	ALFANUMÉRICO	100 CARACTERES			ENDEREÇO - LOGRADOURO
AddressNumber	ALFANUMÉRICO	30 CARACTERES			NÚMERO DO ESTABELICIMENTO
AddressComplement	ALFANUMÉRICO	150 CARACTERES			COMPLEMENTO - EX: FUNDOS
District	ALFANUMÉRICO	255 CARACTERES			BAIRRO
City	ALFANUMÉRICO	50 CARACTERES			CIDADE
State	ALFANUMÉRICO	2 CARACTERES			UF - AC,SC,SP...
CEP	ALFANUMÉRICO	20 CARACTERES
PhoneContact	ALFANUMÉRICO	30 CARACTERES			TELEFONE OU CELULAR
DateRegister	DATA	***	YYYY-MM-DD		DATA DO RESGATE
AmountPremium	NÚMERO	***			QUANTIDADE DO PRÊMIO - PADRÃO = 1
PricePremium	VALOR	***	0.00	APENAS PARA FAIXA LIVRE	VALOR DO PRODUTO
PayBillBarcode	NÚMERO LONGO	47 / 48 CARACTERES		APENAS PARA PAGUE CONTAS	CÓDIGO DE BARRA (BOLETO OU CONSUMO)
PayBillValue	VALOR	***	0.00	APENAS PARA PAGUE CONTAS	VALOR DO BOLETO DE CONSUMO (ÁGUA, GÁS, TELEFONE...)
CodeCard	ALFANUMÉRICO	500 CARACTERES		APENAS PARA PRÉ-PAGO	CÓDIGO DO CARTÃO PRÉ-PAGO

Exemplo de requisição:

POST /api/v3/addresquest HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer MU_mz1OelXdFQ4azFQx0-xAd4gM5RXaA4udbuXTEkigg_CENDCbwFgwJQZPxU434a1OEmUmeVhDBFRFc6UpGhjlXRs3a_1WT2STHVZnmHecg3U60fz
Content-Length: 322
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Exemplo de resposta:

{
   "Success": true,
   "MessageReturn": "Inserido com sucesso."
}

Dados da resposta

NOME DA COLUNA	TIPO	FORMATO	INFORMAÇÃO
Success	BOLEANO		TRUE - SUCESSO FALSE - ERROR
MessageReturn	ALFANUMÉRICO		INFORMAÇÃO EM DESCRIÇÃO

Verificar pedido

GET: /api/v3/existrequest

Serviço resposável em identificar pedido do lote. Além de reconhecer de maneira rápida se existe o pedido na base de dados da Incentivale.

NOME DA COLUNA	TIPO	LIMITE	FORMATO	OBRIGATÓRIO	INFORMAÇÃO
Token	ALFANUMÉRICO	***			IDENTIFICAÇÃO DA CAMPANHA
CodRequest	ALFANUMÉRICO	***			CONTROLE DO CLIENTE

Exemplo de requisição:

GET /api/v3/existrequest HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer MU_mz1OelXdFQ4azFQx0-xAd4gM5RXaA4udbuXTEkigg_CENDCbwFgwJQZPxU434a1OEmUmeVhDBFRFc6UpGhjlXRs3a_1WT2STHVZnmHecg3U60fz
Content-Length: 322
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Token=a17b1c6358454dfeb5fa3fa0d3d592a1&CodRequest=65886

Exemplo de resposta:

{
   "Success": true,
   "MessageReturn": "Encontrado",
   "ListLote": 2
}

Dados da resposta

NOME DA COLUNA	TIPO	INFORMAÇÃO
Success	BOLEANO	TRUE - SUCESSO FALSE - ERROR
MessageReturn	ALFANUMÉRICO	INFORMAÇÃO EM DESCRIÇÃO
ListLote	LISTA	ITENS DO LOTE

Tracking do pedido

GET: /api/v3/findtracking

Serviço resposável em identificar cada pedido individualmente, todos os pedidos acima de 3 (três) itens são enviados em lote.
Ex: Pedido XXX com 5 itens = (Lote um - 2 itens / Lote dois - 3 itens)

NOME DA COLUNA	TIPO	LIMITE	FORMATO	OBRIGATÓRIO	INFORMAÇÃO
Token	ALFANUMÉRICO	***			IDENTIFICAÇÃO DA CAMPANHA
CodRequest	ALFANUMÉRICO	***			CONTROLE DO CLIENTE

Exemplo de requisição:

GET /api/v3/findtracking HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer MU_mz1OelXdFQ4azFQx0-xAd4gM5RXaA4udbuXTEkigg_CENDCbwFgwJQZPxU434a1OEmUmeVhDBFRFc6UpGhjlXRs3a_1WT2STHVZnmHecg3U60fz
Content-Length: 322
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Token=a17b1c6358454dfeb5fa3fa0d3d592a1&CodRequest=65886

Exemplo de resposta:

{
   "Success": true,
   "MessageReturn": "Sucesso.",
   "ListLote":    
    [
      {
         "Rescue": "TRF00222-1",
         "AmountPremium": 3,
         "PricePremium": 90,
         "DateRequest": "2017-06-28T01:07:11.037",
         "DatePosting": null,
         "DateDelivery": null,
         "StatusId": 1,
         "Status": "Pendente",
         "Note": null,
         "Label": "DE234348769BR",
         "CodeCard": "SDFSD4554345RFFSDFS"
      },{
         "Rescue": "TRF00222-2",
         "AmountPremium": 2,
         "PricePremium": 60,
         "DateRequest": "2017-06-28T01:07:13.57",
         "DatePosting": null,
         "DateDelivery": null,
         "StatusId": 1,
         "Status": "Pendente",
         "Note": null,
         "Label": "DE234778769BR",
         "CodeCard": "SDFSDFSD534534645DFG"
      }
   ]
}

Dados da resposta

NOME DA COLUNA	TIPO	FORMATO	INFORMAÇÃO
Success	BOLEANO		TRUE - SUCESSO FALSE - ERROR
MessageReturn	ALFANUMÉRICO		INFORMAÇÃO EM DESCRIÇÃO
ListLote	LISTA		ITENS DO LOTE
Rescue	ALFANUMÉRICO		CONTROLE DA INCENTIVALE
AmountPremium	NÚMERO		QUANTIDADE DO PRÊMIO
PricePremium	VALOR		VALOR DO PRODUTO
DateRequest	DATA	YYYY-MM-DDT00:00:00	DATA DO PEDIDO
DatePosting	DATA	YYYY-MM-DDT00:00:00	DATA DA POSTAGEM
DateDelivery	DATA	YYYY-MM-DDT00:00:00	DATA DA ENTREGA
StatusId	NÚMERO		1 - PENDENTE 2 - CODIFICADO 3 - ENTREGUE 4 - DEVOLVIDO 5 - ENCAMINHADO 6 - EXTRAVIO 7 - CANCELADO 8 - OUTRO 9 - AGUARDANDO RETIRADA NA AGÊNCIA
Status	ALFANUMÉRICO		INFORMAÇÃO EM DESCRIÇÃO
Note	ALFANUMÉRICO		INFORMAÇÕES E OBSERVAÇÕES
Label	ALFANUMÉRICO		ETIQUETA DO CORREIO
CodeCard	ALFANUMÉRICO		CÓDIGO DO CARTÃO

Os dois serviços abaixo são para transações online de códigos virtuais, e devem ser negociados com o comercial da Incentivale antes de serem executados.

Verificar disponibilidade de e-gift online

GET: /api/v3/availabilitystockegift

Serviço responsável em verificar disponibilidade de estoque de códigos virtuais. Exclusivo para transações online, previamente acordadas com o comercial da Incentivale.

NOME DA COLUNA	TIPO	LIMITE	INFORMAÇÃO
Token	ALFANUMÉRICO	***	IDENTIFICAÇÃO DA CAMPANHA
SKU	ALFANUMÉRICO	***	IDENTIFICADOR(SKU) DO CATÁLOGO
AmountPremium	NÚMERO	***	QUANTIDADE DO PRÊMIO - PADRÃO = 1

Exemplo de requisição:

GET api/v3/availabilitystockegift HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer MU_mz1OelXdFQ4azFQx0-xAd4gM5RXaA4udbuXTEkigg_CENDCbwFgwJQZPxU434a1OEmUmeVhDBFRFc6UpGhjlXRs3a_1WT2STHVZnmHecg3U60fz
Content-Length: 322
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Token=a17b1c6358454dfeb5fa3fa0d3d592a1&CodRequest=65886

Exemplo de resposta:

{
"Success": true,
"MessageReturn": "Produto disponível",
"Availability": true
}

Dados da resposta

NOME DA COLUNA	TIPO	INFORMAÇÃO
Success	BOLEANO	TRUE - SUCESSO FALSE - ERROR
MessageReturn	ALFANUMÉRICO	INFORMAÇÃO EM DESCRIÇÃO
Availability	BOLEANO	TRUE - SUCESSO FALSE - ERROR

Transação e-gift online

POST: /api/v3/transactionegift

Requisito: Esse parâmetro deve ser enviado como "Content-Type: application/x-www-form-urlencoded"

Serviço responsável em efetivar o pedido de e-gift online. Exclusivo para transações online, previamente acordadas com o comercial da Incentivale.

NOME DA COLUNA	TIPO	LIMITE	INFORMAÇÃO
Token	ALFANUMÉRICO	***	IDENTIFICAÇÃO DA CAMPANHA
CodRequest	ALFANUMÉRICO	***	CONTROLE DO CLIENTE
SKU	ALFANUMÉRICO	***	IDENTIFICADOR(SKU) DO CATÁLOGO
AmountPremium	NÚMERO	***	QUANTIDADE DO PRÊMIO - PADRÃO = 1
Name	ALFANUMÉRICO	200 CARACTERES	NOME DO BENEFICIÁRIO
CPF_CNPJ	ALFANUMÉRICO	30 CARACTERES	IDENTIFICAÇÃO - CPF OU CNPJ
Email	ALFANUMÉRICO	100 CARACTERES	E-MAIL DO BENEFICIÁRIO

Exemplo de requisição:

GET api/v3/transactionegift HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer MU_mz1OelXdFQ4azFQx0-xAd4gM5RXaA4udbuXTEkigg_CENDCbwFgwJQZPxU434a1OEmUmeVhDBFRFc6UpGhjlXRs3a_1WT2STHVZnmHecg3U60fz
Content-Length: 322
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Token=a17b1c6358454dfeb5fa3fa0d3d592a1&CodRequest=65886

Exemplo de resposta:

{
"Success": true,
"MessageReturn": "Transação realizada com sucesso.",
"Availability": true,
"CodeCard": [
    {
        "Code": "10000000079622150",
        "DateExpiration": "2050-09-19T00:00:00"
    },
    {
        "Code": "10000000059622178",
        "DateExpiration": "2050-09-19T00:00:00"
    }
]
}

Dados da resposta

NOME DA COLUNA	TIPO	INFORMAÇÃO
Success	BOLEANO	TRUE - SUCESSO FALSE - ERROR
MessageReturn	ALFANUMÉRICO	INFORMAÇÃO EM DESCRIÇÃO
Availability	BOLEANO	TRUE - SUCESSO FALSE - ERROR
CodeCard	LISTA	CÓDIGOS DOS CARTÕES

API baseada em OAuth de integração - 3.0

A empresa permite a integração a sistemas externos, tais como ERPs, CRMs e sites empresariais. Podendo oferecer consultoria a sua solução.

Antes de iniciar a integração, será necessário entrar em contato com a equipe da Incentivale para solicitar o usuário e senha além do token da campanha.

Precisa de um Help? Segue o projeto em POSTMAN :)

Requisição por HTTP com resposta em REST

Autenticação - Requisição do Access Token

POST: /oauth/token

Parâmetros:

grant_type: necessário informar "password".

username: usuário de autenticação.

password: senha de autenticação.

Requisito: Esse parâmetro deve ser enviado como "Content-Type: application/x-www-form-urlencoded"

Exemplo de resposta:

O tempo de validade do token são de 60 minutos.

Buscar produtos do catálogo

GET: /api/v3/products?token=xxxxxxx

Parâmetros:

Token: Identificação da campanha.

Serviço resposável em identificar os produtos do catálogo, negociado anteriormente junto ao comercial da Incentivale. Todos os produtos são identificados pelo SKU.

Exemplo de requisição:

Exemplo de resposta:

Dados da resposta

Enviar pedido

POST: /api/v3/addresquest

Requisito: Esse parâmetro deve ser enviado como "Content-Type: application/x-www-form-urlencoded"

Cartão físico, cartão virtual, recarga de celular e pague contas.

Exemplo de requisição:

Exemplo de resposta:

Dados da resposta

Verificar pedido

GET: /api/v3/existrequest

Serviço resposável em identificar pedido do lote. Além de reconhecer de maneira rápida se existe o pedido na base de dados da Incentivale.

Exemplo de requisição:

Exemplo de resposta:

Dados da resposta

Tracking do pedido

GET: /api/v3/findtracking

Serviço resposável em identificar cada pedido individualmente, todos os pedidos acima de 3 (três) itens são enviados em lote. Ex: Pedido XXX com 5 itens = (Lote um - 2 itens / Lote dois - 3 itens)

Exemplo de requisição:

Exemplo de resposta:

Dados da resposta

Os dois serviços abaixo são para transações online de códigos virtuais, e devem ser negociados com o comercial da Incentivale antes de serem executados.

Verificar disponibilidade de e-gift online

GET: /api/v3/availabilitystockegift

Serviço responsável em verificar disponibilidade de estoque de códigos virtuais. Exclusivo para transações online, previamente acordadas com o comercial da Incentivale.

Exemplo de requisição:

Exemplo de resposta:

Dados da resposta

Transação e-gift online

POST: /api/v3/transactionegift

Requisito: Esse parâmetro deve ser enviado como "Content-Type: application/x-www-form-urlencoded"

Serviço responsável em efetivar o pedido de e-gift online. Exclusivo para transações online, previamente acordadas com o comercial da Incentivale.

Exemplo de requisição:

Exemplo de resposta:

Dados da resposta

Serviço resposável em identificar cada pedido individualmente, todos os pedidos acima de 3 (três) itens são enviados em lote.
Ex: Pedido XXX com 5 itens = (Lote um - 2 itens / Lote dois - 3 itens)