English
API based OAuth - 3.0
The company enables integration to external systems such as ERPs, CRMs and business sites. Being able to offer advice to your solution.
Check our special projects team and share our expertise to develop solutions tailor- made for your incentive campaign, reward or promotion.
We work focused on gift cards, tickets and vouchers, to give comprehensive solutions to our enterprise customers, from the supply of the cards in ad-hoc requests or on-demand with operational processing and managing logistics door-to-door in Brazil.
Before starting the integration, you will need to contact the Incentivale team to request the user and password in addition to the campaign token.
Do you need help? below the project in POSTMAN :)
Open Collection Doc
Request for HTTP with response in REST
Authentication - Request for Access Token
POST: /oauth/token
Parameters:
grant_type: inform "password".
username: Authentication user.
password: Authentication password.
Requirement: This parameter should be sent as "Content-Type: application/x-www-form-urlencoded"
Example received:
{
"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"
}
The validity time of the token is 60 min.
Search catalog products
GET: /api/v3/products?token=xxxxxxx
Parameters:
Token: Campaign ID.
Service responsible for identifying the products in the catalog, previously negotiated with the Incentivale commercial. All products are identified by the SKU.
Example sending:
GET /api/v3/products?token=a17b1c6358454dfeb5fa3fa0d3d592a1 HTTP/1.1
Authorization: Bearer MU_mz1OelXdFQ4azFQx0-xAd4gM5RXaA4udbuXTEkigg_CENDCbwFgwJQZPxU434a1OEmUmeVhDBFRFc6UpGhjlXRs3a_1WT2STHVZnmHecg3U60fz
Example received:
{
"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"
}
]
}
Response data
| NAME OF COLUMN | TYPE | FORMAT | OBS |
|---|---|---|---|
| Success | BOOLEAN |
TRUE - SUCCESS FALSE - ERRO |
|
| MessageReturn | ALPHANUMERIC | INFORMATION IN DESCRIPTION | |
| Products | LIST | PRODUCTS | |
| SKU | ALPHANUMERIC | IDENTIFIER(SKU) OF CATALOG | |
| IsFreeRange | BOOLEAN | PRODUCT FREE BAND | |
| IsVirtual | BOOLEAN | PRODUCT VIRTUAL | |
| IsDownloadable | BOLEANO | Product is rechargeable | |
| ParentRechargeProduct | BOLEANO | Product is rechargeable - Above | |
| PriceUN | DECIMAL | UNITARY VALUE | |
| RateADM | DECIMAL | ADMINISTRATE TAX | |
| Freight | DECIMAL | FREIGHT VALUE | |
| Handling | DECIMAL | HANDLING VALUE | |
| PriceTotal | DECIMAL | TOTAL | |
| Name | ALPHANUMERIC | PRODUCT NAME | |
| Description | ALPHANUMERIC | DESCRIPTION OF THE PRODUCT - REGULATION | |
| Enable | BOOLEAN | ACTIVE PRODUCT | |
| LinkImageSmall | ALPHANUMERIC | LINK - SMALL PICTURE | |
| LinkImageMedium | ALPHANUMERIC | LINK - MEDIUM IMAGE | |
| LinkImageLarge | ALPHANUMERIC | LINK - BIG PICTURE | |
| CategoryId | NUMERIC | CATEGORY IDENTIFIER | |
| Category | ALPHANUMERIC | CATEGORY DESCRIPTION |
Send request
POST: /api/v3/addresquest
Requirement: Requirement: This parameter should be sent as "Content-Type: application/x-www-form-urlencoded"
Physical card, virtual card, mobile phone recharge and pay bills.
| NAME OF COLUMN | TYPE | LIMIT | FORMAT | REQUERID | OBS |
|---|---|---|---|---|---|
| Token | ALPHANUMERIC | *** | CAMPAIGN IDENTIFICATION | ||
| CodRequest | NUMERIC | *** | CUSTOMER CONTROL | ||
| SKU | ALPHANUMERIC | *** | NUMERIC(SKU) OF CATALOG | ||
| Name | ALPHANUMERIC | 200 CHARACTERS | NAME OF CLIENT | ||
| CPF_CNPJ | ALPHANUMERIC | 30 CHARACTERS | IDENTICATION ID - DOCUMENT | ||
| ALPHANUMERIC | 100 CHARACTERS | EMAIL OF CLIENT | |||
| Address | ALPHANUMERIC | 100 CHARACTERS | ADDRESS COMPLETE | ||
| AddressNumber | ALPHANUMERIC | 30 CHARACTERS | NÚMERO DO ESTABELICIMENTO | ||
| AddressComplement | ALPHANUMERIC | 150 CHARACTERS | NUMBER OF ADDRESS | ||
| District | ALPHANUMERIC | 255 CHARACTERS | DISTRICT OF ADDRESS | ||
| City | ALPHANUMERIC | 50 CHARACTERS | CITY | ||
| State | ALPHANUMERIC | 2 CHARACTERS | AL, AK, AR, AZ, CA ... | ||
| CEP | ALPHANUMERIC | 20 CARACTERES | POSTAL CODE COUNTRY | ||
| PhoneContact | ALPHANUMERIC | 30 CHARACTERS | PHONE | ||
| DateRegister | DATE | *** | YYYY-MM-DD | DATE OF SEND | |
| AmountPremium | NUMERIC | *** | AMOUNT PREMIUM - DEFAULT = 1 | ||
| PricePremium | DECIMAL | *** | 0.00 | ONLY FREE TRIAL | PRODUCT VALUE |
| PayBillBarcode | NUMERIC | 47 / 48 CHARACTERS | ONLY PAY ACCOUNTS | BARCODE | |
| PayBillValue | DECIMAL | *** | 0.00 | ONLY PAY ACCOUNTS | INVOICE AMOUNT |
| CodeCard | ALPHANUMERIC | 500 CHARACTERS | ONLY PREPAID | CODE |
Example sending:
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)
Example received:
{
"Success": true,
"MessageReturn": "Inserido com sucesso."
}
Datas of received
| NAME OF COLUMN | TYPE | FORMAT | OBS |
|---|---|---|---|
| Success | BOOLEAN |
TRUE - SUCCESS FALSE - ERRO |
|
| MessageReturn | ALPHANUMERIC | INFO |
Check request
GET: /api/v3/existrequest
Requirement: Requirement: This parameter should be sent as "Content-Type: application/x-www-form-urlencoded"
Service responsible for identifying batch request. In addition to quickly recognizing if the request exists in the Incentivale database.
| NAME OF COLUMN | TYPE | LIMIT | FORMAT | REQUERID | OBS |
|---|---|---|---|---|---|
| Token | ALPHANUMERIC | *** | CAMPAIGN IDENTIFICATION | ||
| CodRequest | ALPHANUMERIC | *** | CUSTOMER CONTROL |
Example sending:
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
Example received:
{
"Success": true,
"MessageReturn": "Encontrado",
"ListLote": 2
}
Datas of received
| NAME OF COLUMN | TYPE | FORMAT | OBS |
|---|---|---|---|
| Success | BOOLEAN |
TRUE - SUCCESS FALSE - ERRO |
|
| MessageReturn | ALPHANUMERIC | INFO | |
| ListLote | LIST | LOT ITEMS |
Order Tracking
GET: /api/v3/findtracking
Service responsible for identifying each order individually, all orders above 3 (three) items are shipped in bulk.
Ex: Order XXX with 5 items = (Lot one - 2 items / Lot two - 3 items)
| NAME OF COLUMN | TYPE | LIMIT | FORMAT | REQUERID | OBS |
|---|---|---|---|---|---|
| Token | ALPHANUMERIC | *** | CAMPAIGN IDENTIFICATION | ||
| CodRequest | ALPHANUMERIC | *** | CUSTOMER CONTROL |
Example sending:
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
Example received:
{
"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"
}
]
}
Datas of received
| NAME OF COLUMN | TYPE | FORMAT | OBS |
|---|---|---|---|
| Success | BOOLEAN |
TRUE - SUCCESS FALSE - ERRO |
|
| MessageReturn | ALPHANUMERIC | INFO | |
| ListLote | LIST | LOT ITEMS | |
| Rescue | ALPHANUMERIC | CONTROL | |
| AmountPremium | NUMERIC | AMOUNT OF PREMIUM | |
| PricePremium | DECIMAL | PRODUCT VALUE | |
| DateRequest | DATE | YYYY-MM-DDT00:00:00 | REQUEST DATE |
| DatePosting | DATA | YYYY-MM-DDT00:00:00 | POSTING DATE |
| DateDelivery | DATA | YYYY-MM-DDT00:00:00 | DELIVERY DATE |
| StatusId | NUMERIC |
1 - PENDING 2 - ENCODED 3 - DELIVERY 4 - RETURNED 5 - FORWARDED 6 - LOSS 7 - CANCELED 8 - WAITINGWITHDRAWAL |
|
| Status | ALPHANUMERIC | INFORMATION OF REQUEST | |
| Note | ALPHANUMERIC | ||
| Label | ALPHANUMERIC | ||
| CodeCard | ALPHANUMERIC |
The two services below are for online transactions of virtual codes, and must be negotiated with the Incentivale commercial before they are executed.
Check Availability E-gift
GET: /api/v3/availabilitystockegift
Service responsible for verifying availability of virtual code stock. Exclusive to online transactions, previously agreed with the Incentivale commercial.
| NAME OF COLUMN | TYPE | LIMIT | FORMAT | REQUERID | OBS |
|---|---|---|---|---|---|
| Token | ALPHANUMERIC | *** | CAMPAIGN IDENTIFICATION | ||
| SKU | ALPHANUMERIC | *** | NUMERIC(SKU) OF CATALOG | ||
| AmountPremium | NUMERIC | *** | AMOUNT PREMIUM - DEFAULT = 1 |
Example sending:
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
Example received:
{
"Success": true,
"MessageReturn": "Produto disponível",
"Availability": true
}
Datas of received
| NAME OF COLUMN | TYPE | FORMAT | OBS |
|---|---|---|---|
| Success | BOOLEAN |
TRUE - SUCCESS FALSE - ERRO |
|
| MessageReturn | ALPHANUMERIC | INFORMATION IN DESCRIPTION | |
| Availability | BOOLEAN |
TRUE - AVAILABLE FALSE - NOT AVAILABLE |
Transaction E-gift
POST: /api/v3/transactionegift
Requirement: This parameter should be sent as "Content-Type: application/x-www-form-urlencoded"
Service responsible for effecting the e-gift request online. Exclusive to online transactions, previously agreed with the Incentivale commercial.
| NAME OF COLUMN | TYPE | LIMIT | FORMAT | REQUERID | OBS |
|---|---|---|---|---|---|
| Token | ALPHANUMERIC | *** | CAMPAIGN IDENTIFICATION | ||
| CodRequest | ALPHANUMERIC | *** | CUSTOMER CONTROL | ||
| SKU | ALPHANUMERIC | *** | NUMERIC(SKU) OF CATALOG | ||
| AmountPremium | NUMERIC | *** | AMOUNT PREMIUM - DEFAULT = 1 | ||
| Name | ALPHANUMERIC | 200 CHARACTERS | NAME OF CLIENT | ||
| CPF_CNPJ | ALPHANUMERIC | 30 CHARACTERS | IDENTICATION ID - DOCUMENT | ||
| ALPHANUMERIC | 100 CHARACTERS | EMAIL OF CLIENT |
Example sending:
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
Example received:
{
"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"
}
]
}
Response data
| NAME OF COLUMN | TYPE | FORMAT | OBS |
|---|---|---|---|
| Success | BOOLEAN |
TRUE - SUCCESS FALSE - ERRO |
|
| MessageReturn | ALPHANUMERIC | INFORMATION IN DESCRIPTION | |
| Availability | BOOLEAN |
TRUE - SUCCESS FALSE - ERRO |
|
| CodeCard | LIST | CODE |