English
API baseada em OAuth de integração - 2.0 - Nova API disponível - v3
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.
Requisição por HTTP com resposta em REST
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.
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@v2api.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/v2/products?token=xxxxxxx
Parâmetros:
Token: Identificação da campanha.
Exemplo de requisição:
GET /api/v2/products?token=a17b1c6358454dfeb5fa3fa0d3d592a1 HTTP/1.1
Authorization: Bearer MU_mz1OelXdFQ4azFQx0-xAd4gM5RXaA4udbuXTEkigg_CENDCbwFgwJQZPxU434a1OEmUmeVhDBFRFc6UpGhjlXRs3a_1WT2STHVZnmHecg3U60fz
Exemplo de resposta:
{
"$id": "1",
"CodeReturn": 0,
"MessageReturn": "Sucesso",
"Products":
[
{
"$id": "2",
"SKU": "4",
"PriceCard": "120,00",
"PriceUN": "132,90",
"Name": "CARTÃO PRESENTE ANNA PEGOVA R$ 120,00 ",
"Description": "O Cartão Presente Anna Pegova é uma novidade irresistível para quem quer presentear alguém especial. Validade 1 ano.",
"Enable": 1,
"LinkImage": "https://central.incentivale.com.br/StorangeFiles/86318fd8951c4c4297488edd9debba7d.png",
"CategoryId": 1,
"Category": "VARIEDADES",
"TagFind": "ANNA PEGOVA"
},
{
"$id": "3",
"SKU": "5",
"PriceCard": "200,00",
"PriceUN": "212,90",
"Name": "CARTÃO PRESENTE ANNA PEGOVA R$ 200,00 ",
"Description": "O Cartão Presente Anna Pegova é uma novidade irresistível para quem quer presentear alguém especial. Validade 1 ano.",
"Enable": 1,
"LinkImage": "https://central.incentivale.com.br/StorangeFiles/86318fd8951c4c4297488edd9debba7d.png",
"CategoryId": 1,
"Category": "VARIEDADES",
"TagFind": "ANNA PEGOVA"
},
{
"$id": "4",
"SKU": "6",
"PriceCard": "40,00",
"PriceUN": "52,90",
"Name": "CARTÃO PRESENTE ANNA PEGOVA R$ 40,00 ",
"Description": "O Cartão Presente Anna Pegova é uma novidade irresistível para quem quer presentear alguém especial. Validade 1 ano.",
"Enable": 1,
"LinkImage": "https://central.incentivale.com.br/StorangeFiles/86318fd8951c4c4297488edd9debba7d.png",
"CategoryId": 1,
"Category": "VARIEDADES",
"TagFind": "ANNA PEGOVA"
}
]
}
Enviar pedido
POST: /api/v2/addresquest
Requisito: Esse parâmetro deve ser enviado como "Content-Type: application/x-www-form-urlencoded"
| NOME DA COLUNA | TIPO | LIMITE | FORMATO | OBRIGATÓRIO | INFORMAÇÃO |
|---|---|---|---|---|---|
| Token | ALFANUMÉRICO | *** | IDENTIFICAÇÃO DA CAMPANHA | ||
| CodRequest | ALFANUMÉRICO | *** | CONTROLE DO CLIENTE | ||
| SKU | NÚMERO | *** | NÚMERO(SKU) DO CATÁLOGO | ||
| Name | ALFANUMÉRICO | 200 CARACTERES | NOME DO BENEFICIÁRIO | ||
| CPF_CNPJ | ALFANUMÉRICO | 30 CARACTERES | IDENTIFICAÇÃO - CPF OU CNPJ | ||
| 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 |
Exemplo de requisição:
POST /api/v2/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
Host: central.incentivale.com.br
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Token=a17b1c6358454dfeb5fa3fa0d3d592a1&CodRequest=558788&SKU=49&Name=Eduardo%20Crist%C3%B3v%C3%A3o%20da%20silva&CPF_CNPJ=075.478.769-55&Email=eduardosilva%40gmail.com&Address=Rua%20frederico%20jorge&AddressNumber=255&Complement=Apto%2025%20bloco%20b&District=Centro&City=Blumenau&State=SC&CEP=8978858&PhoneContact=92555699
Exemplo de resposta:
{
"$id": "1",
"CodeReturn": 0,
"MessageReturn": "Inserido com sucesso.",
"PricePremium": 212.9,
"PriceFreight": 0,
"PriceTotalRequest": 212.9
}
Dados da resposta
| NOME DA COLUNA | TIPO | FORMATO | INFORMAÇÃO |
|---|---|---|---|
| CodeReturn | NÚMERO |
0 - INSERIDO COM SUCESSO 1 - ERROR |
|
| MessageReturn | ALFANUMÉRICO | INFORMAÇÃO EM DESCRIÇÃO | |
| PricePremium | VALOR | VALOR DO PRÊMIO | |
| PriceFreight | VALOR | VALOR DO FRETE | |
| PriceTotalRequest | VALOR | VALOR TOTAL DO PEDIDO | |
| DateRequest | DATA | DATA DO PEDIDO |
Verificar pedido
POST: /api/v2/existrequest
Requisito: Esse parâmetro deve ser enviado como "Content-Type: application/x-www-form-urlencoded"
| 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:
POST /api/v2/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
Host: central.incentivale.com.br
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Token=a17b1c6358454dfeb5fa3fa0d3d592a1&CodRequest=65886
Exemplo de resposta:
{
"$id": "1",
"CodeReturn": 0,
"MessageReturn": "Sucesso."
}
Dados da resposta
| NOME DA COLUNA | TIPO | FORMATO | INFORMAÇÃO |
|---|---|---|---|
| CodeReturn | NÚMERO |
0 - ENCONTRADO 1 - NÃO ENCONTRADO |
|
| MessageReturn | ALFANUMÉRICO | INFORMAÇÃO EM DESCRIÇÃO |
Buscar pedido
POST: /api/v2/findrequest
Requisito: Esse parâmetro deve ser enviado como "Content-Type: application/x-www-form-urlencoded"
| 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:
POST /api/v2/findrequest HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer MU_mz1OelXdFQ4azFQx0-xAd4gM5RXaA4udbuXTEkigg_CENDCbwFgwJQZPxU434a1OEmUmeVhDBFRFc6UpGhjlXRs3a_1WT2STHVZnmHecg3U60fz
Content-Length: 322
Host: central.incentivale.com.br
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Token=a17b1c6358454dfeb5fa3fa0d3d592a1&CodRequest=65886
Exemplo de resposta:
{
"$id": "1",
"CodeReturn": 0,
"MessageReturn": "Sucesso.",
"PricePremium": 212.9,
"Amount": 3,
"PriceFreight": 0,
"PriceTotalRequest": 212.9,
"DateRequest": "2016-05-11T12:48:36.29"
}
Dados da resposta
| NOME DA COLUNA | TIPO | FORMATO | INFORMAÇÃO |
|---|---|---|---|
| CodeReturn | NÚMERO |
0 - SUCESSO 1 - ERROR |
|
| MessageReturn | ALFANUMÉRICO | INFORMAÇÃO EM DESCRIÇÃO | |
| PricePremium | VALOR | VALOR DO PRÊMIO | |
| Amount | NÚMERO | QUANTIDADE DO PRÊMIO | |
| PriceFreight | VALOR | VALOR DO FRETE | |
| PriceTotalRequest | VALOR | VALOR TOTAL DO PEDIDO | |
| DateRequest | DATA | YYYY-MM-DDT00:00:00 | DATA DO PEDIDO |
Tracking do pedido
POST: /api/v2/findtracking
Requisito: Esse parâmetro deve ser enviado como "Content-Type: application/x-www-form-urlencoded"
| 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:
POST /api/v2/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
Host: central.incentivale.com.br
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Token=a17b1c6358454dfeb5fa3fa0d3d592a1&CodRequest=65886
Exemplo de resposta:
{
"$id": "1",
"CodeReturn": 0,
"MessageReturn": "Sucesso.",
"DateRequest": "2016-05-11T12:48:36.29",
"DatePosting": null,
"DateDelivery": null,
"StatusId": 1,
"Status": "Pendente",
"Note": null,
"Label": null
}
Dados da resposta
| NOME DA COLUNA | TIPO | FORMATO | INFORMAÇÃO |
|---|---|---|---|
| CodeReturn | NÚMERO |
0 - SUCESSO 1 - ERROR |
|
| MessageReturn | ALFANUMÉRICO | INFORMAÇÃO EM DESCRIÇÃO | |
| 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 |