Back to top

IA API ( For 'General' Role )

* Maximum 20 API call per minute

Resource Group

Authenticate

Authenticate resource representation.

Getting token
POST/authenticate

Getting token using ‘secret’ and ‘key’

Example URI

POST https://api.involve.asia/api/authenticate
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "secret": "4ZU659+Ba4LjcSVGamz0LYnA3zYSKLDQgN3DriAzyH4=",
  "key": "general"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "message": "",
  "data": {
    "token": ""
  }
}

Conversions

Conversion resource representation.

Getting a full list of conversions
POST/conversions/all

Example URI

POST https://api.involve.asia/api/conversions/all
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer [token]
Body
{
  "page": "1",
  "limit": "100",
  "filters": {
    "conversion_id": "899191|7008168",
    "offer_id": "25",
    "offer_name": "lazada",
    "conversion_status": "pending",
    "preferred_currency": "USD"
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "message": "",
  "data": {
    "page": 1,
    "limit": 100,
    "count": 246,
    "nextPage": 2,
    "data": [
      {
        "conversion_id": 899191,
        "offer_name": "Lazada (PH)",
        "offer_id": 44,
        "sale_amount": "345.00",
        "currency": "PHP",
        "payout": "14.49",
        "aff_sub1": null,
        "aff_sub2": null,
        "aff_sub3": null,
        "aff_sub4": null,
        "aff_sub5": null,
        "adv_sub1": "348666368",
        "adv_sub2": "Health & Beauty",
        "adv_sub3": "false",
        "adv_sub4": "AD109HBAK1YRANPH-611385",
        "adv_sub5": "6.00",
        "datetime_conversion": "2017-02-22 21:16:47",
        "conversion_status": "pending",
        "affiliate_id": 4726,
        "user_id": 2,
        "user_email": "email@gmail.com"
      }
    ]
  }
}

Getting a list of conversions filtered by date
POST/conversions/range

Example URI

POST https://api.involve.asia/api/conversions/range
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer [token]
Body
{
  "start_date": "2017-02-26",
  "end_date": "2017-02-28",
  "page": "1",
  "limit": "100",
  "filters": {
    "conversion_id": "899191|7008168",
    "offer_id": "25",
    "offer_name": "lazada",
    "conversion_status": "pending",
    "preferred_currency": "USD"
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "message": "",
  "data": {
    "page": 1,
    "limit": 100,
    "count": 246,
    "nextPage": 2,
    "data": [
      {
        "conversion_id": 899191,
        "offer_name": "Lazada (PH)",
        "offer_id": 44,
        "sale_amount": "345.00",
        "currency": "PHP",
        "payout": "14.49",
        "aff_sub1": null,
        "aff_sub2": null,
        "aff_sub3": null,
        "aff_sub4": null,
        "aff_sub5": null,
        "adv_sub1": "348666368",
        "adv_sub2": "Health & Beauty",
        "adv_sub3": "false",
        "adv_sub4": "AD109HBAK1YRANPH-611385",
        "adv_sub5": "6.00",
        "datetime_conversion": "2017-02-22 21:16:47",
        "conversion_status": "pending",
        "affiliate_id": 4726,
        "user_id": 2,
        "user_email": "email@gmail.com"
      }
    ]
  }
}

Getting a list of conversions filtered by date and time
POST/conversions/data-range

Example URI

POST https://api.involve.asia/api/conversions/data-range
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer [token]
Body
{
  "start_date": "2017-02-22 21:16:47",
  "end_date": "2017-02-24 14:20:19",
  "page": "1",
  "limit": "100",
  "filters": {
    "conversion_id": "899191|7008168",
    "offer_id": "25",
    "offer_name": "lazada",
    "conversion_status": "pending",
    "preferred_currency": "USD"
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "message": "",
  "data": {
    "page": 1,
    "limit": 100,
    "count": 246,
    "nextPage": 2,
    "data": [
      {
        "conversion_id": 899191,
        "offer_name": "Lazada (PH)",
        "offer_id": 44,
        "sale_amount": "345.00",
        "currency": "PHP",
        "payout": "14.49",
        "aff_sub1": null,
        "aff_sub2": null,
        "aff_sub3": null,
        "aff_sub4": null,
        "aff_sub5": null,
        "adv_sub1": "348666368",
        "adv_sub2": "Health & Beauty",
        "adv_sub3": "false",
        "adv_sub4": "AD109HBAK1YRANPH-611385",
        "adv_sub5": "6.00",
        "datetime_conversion": "2017-02-22 21:16:47",
        "conversion_status": "pending",
        "affiliate_id": 4726,
        "user_id": 2,
        "user_email": "email@gmail.com"
      }
    ]
  }
}

Offer

Offer resource representation.

Getting a full list of offers
POST/offers/all

Example URI

POST https://api.involve.asia/api/offers/all
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer [token]
Body
{
  "page": "1",
  "limit": "100",
  "sort_by": "relevance",
  "filters": {
    "offer_id": 25,
    "offer_name": "lazada",
    "country": "Malaysia",
    "offer_type": "cpa|cps|cpa_both|cpc|cpm",
    "categories": "Electronics|Fashion|Finance|Health & Beauty|Lifestyle|Marketplace|Other|Services|Travel"
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 1,
    "count": 75,
    "nextPage": 2,
    "data": [
      {
        "offer_name": "Medical Departures",
        "description": "Offer Description",
        "preview_url": "https://www.medicaldepartures.com/",
        "offer_id": 289,
        "currency": "USD",
        "logo": "https://img.involve.asia/ia_logo/289.png",
        "lookup_value": "cpa",
        "datetime_updated": "2019-05-31 11:17:36",
        "countries": "International",
        "categories": "Health & Beauty",
        "commissions": [
          {
            "Commission": "USD52.50"
          },
          {
            "Commission": "USD52.50 OR 0.000"
          }
        ],
        "validation_terms": "30",
        "payment_terms": "60",
        "tracking_link": "https://invol.co/aff_m?offer_id=577&aff_id=13972&source=deeplink_generator&url=https%3A%2F%2Fwww.medicaldepartures.com%2F"
      }
    ]
  }
}

Getting list of offers by filtering last updated datetime
POST/offers/last-updated-range

Example URI

POST https://api.involve.asia/api/offers/last-updated-range
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer [token]
Body
{
  "page": "1",
  "limit": "100",
  "start_date": "2017-01-01 00:00:00",
  "end_date": "2017-12-30 23:59:59",
  "sort_by": "relevance",
  "filters": {
    "offer_id": 25,
    "offer_name": "lazada",
    "country": "Malaysia",
    "offer_type": "cpa|cps|cpa_both|cpc|cpm",
    "categories": "Electronics|Fashion|Finance|Health & Beauty|Lifestyle|Marketplace|Other|Services|Travel"
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 1,
    "count": 75,
    "nextPage": 2,
    "data": [
      {
        "offer_name": "Medical Departures",
        "description": "Offer Description",
        "preview_url": "https://www.medicaldepartures.com/",
        "offer_id": 289,
        "currency": "USD",
        "logo": "https://img.involve.asia/ia_logo/289.png",
        "lookup_value": "cpa",
        "datetime_updated": "2019-05-31 11:17:36",
        "countries": "International",
        "categories": "Health & Beauty",
        "commissions": [
          {
            "Commission": "USD52.50"
          },
          {
            "Commission": "USD52.50 OR 0.000"
          }
        ],
        "validation_terms": "30",
        "payment_terms": "60",
        "tracking_link": "https://invol.co/aff_m?offer_id=577&aff_id=13972&source=deeplink_generator&url=https%3A%2F%2Fwww.medicaldepartures.com%2F"
      }
    ]
  }
}

Campaign

Campaign resource representation.

Getting a full list of campaigns
POST/campaigns/all

Example URI

POST https://api.involve.asia/api/campaigns/all
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer [token]
Body
{
  "page": "1",
  "limit": "100",
  "filters": {
    "campaign_banner_id": "123|456",
    "offer_id": "25|815",
    "offer_name": "lazada",
    "start_date": "2017-06-29",
    "end_date": "2017-06-29",
    "country": "Malaysia",
    "category": "Finance|Services|Marketplace|Other|Travel|Health & Beauty|Lifestyle|Electronics|Fashion",
    "coupons_only": true
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 1,
    "count": 71,
    "nextPage": 2,
    "data": [
      {
        "campaign_banner_id": 123,
        "offer_id": 46,
        "offer_name": "Photobook (MY)",
        "campaign_name": "60% OFF storewide!",
        "description": "60% OFF storewide! for all Photobooks",
        "voucher_code": "IARAM60",
        "date_campaign_start": "2017-05-23",
        "date_campaign_end": "2017-06-30",
        "banner_image_url": "https://dev-bkt.s3-ap-southeast-1.amazonaws.com/rpss/campaigns_banners/no-img.jpg",
        "tracking_link": "https://invol.co/aff_m?offer_id=124&aff_id=13972&source=campaign&url=http%3A%2F%2Fwww.photobook.com.my%2Fprp%2Fmay17-aff-involveasia",
        "categories": "Food & Beverage, Lifestyle, Other"
      }
    ]
  }
}

Generated by aglio on 17 Oct 2019