Introduction

Welcome to the API documentation! It provides essential information about the APIs used in the tool, including detailed descriptions of endpoints and CURL.

Authentication

The Veedea API authenticates requests using API keys. Users can access their API keys in the Veedea Dashboard, where each key is prefixed with "api_key."

Since API keys grant significant access, it is crucial to keep them secure and never share them in publicly accessible locations. All API requests must be made over HTTPS. Requests sent over plain HTTP or without proper authentication, will fail.

Authentication End Point

  • method : GET and POST both
  • URL : https://veedea.com/api/auth

    • Parameters

  • api_key : cmF*******************

    • curl get request

  • curl --location
         'https://veedea.com/api/auth?api_key=*******************************' \

    • images

    curl post request

  • curl --location
         'https://veedea.com/api/auth' \
         --form 'api_key="*************************"'

    • images

    Get Campaigns

    The Get Campaigns API is used to get the list of own campaign created in the Veedea Dashboard. We have used the following parameters api_key, limit, page, token.

    The parameter token can be obtained from the Authentication API and please keep it stored for future use.

    Authentication End Point

  • URL : https://veedea.com/api/getcampaign

    • Parameters

  • api_key : cmF*******************
    •
  • limit : 10
    •
  • page :1
    •
  • token : Mj*******************

    •

    curl post request

  • curl --location 'https://veedea.com/api/getcampaign' \
        --header 'Cookie: ci_session=8er5u4l1tbjmtb5bb3873nb8c2eg92e7' \
        --form 'api_key="cmF*******************"' \
        --form 'limit="10"' \
        --form 'page="1"' \
        --form 'token="MjA*********************"

    • images

    curl get request

  • curl --location 'https://veedea.com/api/getcampaign?api_key=******&limit=2&page=1&token=****' \

    • images

    Get Leads

    The Get Leads API is used to get the list of leads of own campaign, created in the Veedea Dashboard. We have used the following parameters api_key, campaign-id,limit, page, token.

    The parameter campaign-id will be generated from the Get Campaign API.

    Authentication End Point

  • URL : https://veedea.com/api/getleads

    • Parameters

  • api_key : cmF*******************
    •
  • campaign-id : 330
    •
  • limit : 10
    •
  • page :1
    •
  • token : MjA*******************

    •

    curl post request

  • curl --location 'https://veedea.com/api/getleads' \
        --header 'Cookie: ci_session=8er5u4l1tbjmtb5bb3873nb8c2eg92e7' \
        --form 'api_key="cmF******************"' \
        --form 'campaign-id="330"' \
        --form 'limit="10"' \
        --form 'page="1"' \
        --form 'token="MjA*********************'

    • images

    curl get request

  • curl --location 'https://veedea.com/api/getleads/?api_key=****&limit=2&page=1&token=***&campaign-id=330' \

    • images

    Get Products

    The Get Products API retrieves a list of leads who purchased products through the campaign, created in the Veedea Dashboard. We have used the following parameters api_key, campaign-id,limit, page, token.

    The parameter campaign-id will be generated from the Get Campaign API.

    Authentication End Point

  • URL : https://veedea.com/api/productpurchase

    • Parameters

  • api_key : cmF*******************
    •
  • campaign-id : 330
    •
  • limit : 10
    •
  • page :1
    •
  • token : MjA*******************

    •

    curl post request

  • curl --location 'https://veedea.com/api/productpurchase' \
        --header 'Cookie: ci_session=8er5u4l1tbjmtb5bb3873nb8c2eg92e7' \
        --form 'api_key="cmF***************"' \
        --form 'campaign-id="330"' \
        --form 'limit="5"' \
        --form 'page="2"' \
        --form 'token="MjA********************"'

    • images

    curl get request

  • curl --location --request GET 'https://veedea.com/api/productpurchase' \

    • images