DigitalRiver - OneNetwork Web Services API for Affiliates

Table of Contents

• Introduction to the DR OneNetwork Direct's Web Services
• Available Function Calls/Actions
• Required for ALL API Calls
• The Functions
  • creativeTypes
  • campaignInfo
  • creativeInfo
  • optionalInfo
  • monthlyStatsInfo
  • dailyStatsInfo
  • getCCampaigns
  • recordHostedLead
  • getAffiliateAggregateStatistics
  • getAffiliateDeployStatistics

Introduction to the DigitalRiver OneNetwork Web Services API

Return to Affiliate Datafeeds Resources.

DigitalRiver OneNetwork has a documentation available on their own network, but I decided to create another documentation anyway, which is a bit more straight forward and compact in my opinion. However, due to the fact that mine is only a copy, the latest changes, if they occur, might not be reflected in my documentation yet. So please use my documentation only as guide and double check with the documentation provided by DR once you actually decided to write an application that makes use of the SOAP Web Services API.

I have to note as a positive aspect of the web services API that it provides access to reporting information in an automated fashion. I am preaching for the need of such access for years, but only few networks and in-house affiliate program software providers actually provided such access in one form or another.

Also note that the API only provides read-access to content that is visible to your network account. You cannot make any changes to any information via the web services API. You cannot apply for programs for example or submit creative activation reqquests etc.

The DR OneNetwork web services is based on SOAP/WSDL. The WSDL definition of the interface is accessible at this URL: http://aff.onenetworkdirect.com/api/soap_affiliate.php?wsdl.

If you are a web developer with little or no experience with web services APIs, I would suggest to you that you check out my resources to SOAP/WSDL Web Services Development.

- top -

Available Function Calls/Actions

The DR OneRiver Web Services API supports 10 different function calls or actions.

• creativeTypes
• campaignInfo
• creativeInfo
• optionalInfo
• monthlyStatsInfo
• dailyStatsInfo
• getCCampaigns
• recordHostedLead
• getAffiliateAggregateStatistics
• getAffiliateDeployStatistics

- top -

Required for ALL API Calls

Return to Affiliate Datafeeds Resources.

The following information, input- or output parameters and settings are the same and required for every API call. I did not repeat those for each individual function over and over again. Please make sure that your code includes the necessary blocks though to prevent malfunctions of the API in your application.

Endpoint: http://aff.onenetworkdirect.com/api/soap_affiliate.php
Style: rpc
Input
  use: encoded
  Namespace: http://soapinterop.org/
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/

Output
  use: encoded
  Namespace: http://soapinterop.org/
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/

Namespace: http://soapinterop.org/
Transport: http://schemas.xmlsoap.org/soap/http

Note: In Addition to that do all calls require the following three input parameters and have the following one output parameter, ALWAYS. They are mandatory and not obligatory!

• Client: digitalriver
• Add Code: CDxxxxx (affiliate id)
• Password: Your Login Password

Input
  parts:
    client: xsd:string
    add_code: xsd:string
    password: xsd:string
Output
  parts:
    return: xsd:string

The Functions

Return to Affiliate Datafeeds Resources.

Now comes the documentation of the 10 API calls. It only contains the parts that are specific to each call. Keep in mind that you have to include the definitions and details specified in the previous paragraph in each API call.

- top -

creativeTypes

Name: creativeTypes
Binding: DigitalriverWebServicesBinding
SoapAction: http://aff.onenetworkdirect.com/api/soap_affiliate.php/creativeTypes

Input:
  message: creativeTypesRequest

Output:
  message: creativeTypesResponse

Documentation:
Creative Types - Retrieve the available and applicable creative types

- top -

campaignInfo

Name: campaignInfo
Binding: DigitalriverWebServicesBinding
SoapAction: http://aff.onenetworkdirect.com/api/soap_affiliate.php/campaignInfo

Input:
  message: campaignInfoRequest
  parts:
    program_id: xsd:int
    ignore_campaign_images: xsd:string
    category: xsd:string

Output:
  message: campaignInfoResponse

Documentation:
Campaign Information - You can retrieve campaign information with the required credentials
Optional Fields - program_id, ignore_campaign_images

- top -

creativeInfo

Name: creativeInfo
Binding: DigitalriverWebServicesBinding
SoapAction: http://aff.onenetworkdirect.com/api/soap_affiliate.php/creativeInfo

Input:
  message: creativeInfoRequest
  parts:
    program_id: xsd:int
    opt_info: xsd:string
    creativeTypeId: xsd:int
    search_criteria: xsd:string
    agreed_to_terms: xsd:int

Output:
  message: creativeInfoResponse

Documentation:
Creative Information - Retrieve all creative information specified for the selected campaign
Required field - program_id
Optional - opt_info, creative type, search criteria

If you have not agreed to terms, you will not receive the creative information for the campaign

- top -

optionalInfo

Name: optionalInfo
Binding: DigitalriverWebServicesBinding
SoapAction: http://aff.onenetworkdirect.com/api/soap_affiliate.php/optionalInfo

Input:
  message: optionalInfoRequest
  parts:
    start_date: xsd:string
    end_date: xsd:string
    program_id: xsd:int
    opt_info: xsd:string

Output:
  message: optionalInfoResponse

Documentation:
Optional Information - Retrieve the leads and sales information for your sub-affiliates
Optional fields - start_date, end_date, program_id, opt_info

- top -

monthlyStatsInfo

Return to Affiliate Datafeeds Resources.

Name: monthlyStatsInfo
Binding: DigitalriverWebServicesBinding
SoapAction: http://aff.onenetworkdirect.com/api/soap_affiliate.php/monthlyStatsInfo

Input:
  message: monthlyStatsInfoRequest
  parts:
    start_date: xsd:string
    end_date: xsd:string
    program_id: xsd:int

Output:
  message: monthlyStatsInfoResponse

Documentation:
Monthy Cumulative Statistics
Optional - start_date, end_date, program_id

- top -

dailyStatsInfo

Name: dailyStatsInfo
Binding: DigitalriverWebServicesBinding
SoapAction: http://aff.onenetworkdirect.com/api/soap_affiliate.php/dailyStatsInfo

Input:
  message: dailyStatsInfoRequest
  parts:
    start_date: xsd:string
    end_date: xsd:string
    program_id: xsd:int

Output:
  message: dailyStatsInfoResponse

Documentation:
Daily Statistics - Retrieve daily statistics
Optional - start_date, end_date, program_id

- top -

getCCampaigns

Name: getCCampaigns
Binding: DigitalriverWebServicesBinding
SoapAction: http://aff.onenetworkdirect.com/api/soap_affiliate.php/getCCampaigns

Input:
  message: getCCampaignsRequest
  parts:
    pool_id: xsd:string
    info: xsd:string

Output:
  message: getCCampaignsResponse

Documentation:
Get Coregistration/Hosted Form Campaign Information
Required fields - Pool ID

- top -

recordHostedLead

Name: recordHostedLead
Binding: DigitalriverWebServicesBinding
SoapAction: http://aff.onenetworkdirect.com/api/soap_affiliate.php/recordHostedLead

Input:
  message: recordHostedLeadRequest
  parts:
    lead: xsd:string
Output:
  message: recordHostedLeadResponse

Documentation:
Record Hosted Form Lead
Required fields - Lead
(The Lead string format is available on the affiliate interface)

- top -

getAffiliateAggregateStatistics

Name: getAffiliateAggregateStatistics
Binding: DigitalriverWebServicesBinding
SoapAction: http://aff.onenetworkdirect.com/api/soap_affiliate.php/getAffiliateAggregateStatistics

Input:
  message: getAffiliateAggregateStatisticsRequest
  parts:
    start_date: xsd:date
    end_date: xsd:date
    campaign_id: xsd:int

Output:
  message: getAffiliateAggregateStatisticsResponse

Documentation:
getAffiliateAggregateStatistics

Required fields: start_date, end_date
Optional Fields: campaign_id - valid program id or empty for all

- top -

getAffiliateDeployStatistics

Return to Affiliate Datafeeds Resources.

Name: getAffiliateDeployStatistics
Binding: DigitalriverWebServicesBinding
SoapAction: http://aff.onenetworkdirect.com/api/soap_affiliate.php/getAffiliateDeployStatistics

Input:
  message: getAffiliateDeployStatisticsRequest
  parts:
    start_date: xsd:date
    end_date: xsd:date
    campaign_id: xsd:int

Output:
  message: getAffiliateDeployStatisticsResponse

Documentation:
getAffiliateDeployStatistics

Required fields: start_date, end_date
Optional Fields: campaign_id - valid program id or empty for all

Other Data Feed Guides, Articles and Resources for Affiliates and Advertisers Resources - Affiliate Datafeeds Resources, Affiliate Program APIs and Web Services Article - Merchant Product Datafeeds for Affilates - 101 Article - XML Datafeeds and Webservices for Affiliates Resources - Web Services Development Resources for Developers Guide - CJ Advanced Links Tutorial and URL Encoding for Adverisers/Merchants and OPMs Guide - Dark Blue Content Feeds Primer Guide - Kolimbo/MyAffiliateProgram by Inuvo, Inc. - Raw Datafeeds 101 Guide - LinkConnector Product Data Feeds for Affiliates 101 Guide - The Linkshare Merchandiser Service - Datafeed Access to Linkshare Feeds - Tips and Tricks Guide - Linkshare Merchandiser Delimited Product Data Feed Format Guide - LinkShare Merchandiser FTP Commands Reference Guide - ShareASale Product Datafeeds for Affiliates and Merchants Guide - Orange Links by the Google Affiliate Network (DoubleClick Performics) - A Primer for Affiliates Guide - DigitalRiver - Data Feeds Provided to Affiliates by OneNetworkDirect Guide - PepperJam Network Product Data Feeds and Store Builder Guide Article - AvantLink Product Data API Introduction Article - What Makes a Good Data Feed? Tips for Merchants - Slides Transcript

- top -

Cumbrowski.com Sponsors

See the Advertiser Kit to learn more about sponsorship opportunities at Cumbrowski.com. Press? Download my Media Kit.

Email Alert & Newsletter (privacy) My Blog Posts and Newsletter (read)

Enter your email address:

or