Offerit - User contributions [en]

Replacement Variables

2023-03-03T17:53:54Z

Offeritnick: /* Landing Page URL Replacement Tokens */

{{Offerit_Manual
| show_setup_section = true
}}

== Landing Page URL Replacement Tokens ==
When tracking with Offerit, surfers will go through our tracking links:
<pre>
http://example.offerit.com/track/<ocode>/
</pre>

After doing our tracking process, we will send the surfer to the landing page URL defined in the admin for the offer and landingpage we see in the "ocode":
<pre>
http://example.com/
</pre>

Offerit Allows you to add replacement tokens to your Offer/Landing Page URL to pass some data along to the landing page. The most common example is to pass our "click_hash" to your landing page so you can use it for reporting transactions and events via postback instead of using iframe/image pixels. Example landing page URL modification to pass this data:
<pre>
http://example.com/?click_hash=%%click_hash%%
</pre>

In the example above our "click_hash" data will be passed to the landing page in a paramter called "click_hash". Please note that you can name the URL parameter anything you'd like to meet your system's needs. For examplem if your system expects this information to be sent in "clickid", you can instead make your landing page URL:
<pre>
http://example.com/?clickid=%%click_hash%%
</pre>

Below is the full list of available Replacement Tokens that can be used with your Landing Page URLs:
* ''%%click_hash%%'' - The Click hash generated by Offerit when a surfer clicks our tracking links
* ''%%click_hash_nodot%%'' - The Click hash generated by Offerit when a surfer clicks our tracking links with all dots/periods (".") removed
* ''%%offer_id%%'' - The Offer ID
* ''%%aff_id%%'' - The Affiliate ID
* ''%%aff_username%%'' - The Affiliate Username
* ''%%aff_campaign%%'' - The Affiliate Campaign ID
* ''%%aff_subid%%'' - The Affiliate Campaign Name
* ''%%country_code%%'' - The 2-letter ISO Country code for the surfer
* ''%%ip%%'' - The surfer's IP address in IPv4 format
* ''%%ip_long%%'' - The surfer's IP address converted from IPv4 to a long integer using PHP's "ip2long" function
* ''%%aff_phone%% (phone offers only)'' - The Phone Number for the affiliate phone offer
* ''%%subaff%%'' - Subaff value if included on tracking link
* ''%%subaff2%%'' - Subaff2 value if included on tracking link
* ''%%subaff3%%'' - Subaff3 value if included on tracking link
* ''%%subaff4%%'' - Subaff4 value if included on tracking link
* ''%%subaff5%%'' - Subaff5 value if included on tracking link

== Affiliate Custom Pixel Replacement Variables ==
=== Standard Replacement Variables ===
Affiliates have the option to add custom pixels or postbacks to inform their systems of sales when they are reported to Offerit. To set these up, use the "My Account" tab in the top navigation while logged in or overridden as them, then click the "Custom Offer Pixels" sub section in the left side navigation:

[[File:CustomOfferPixels.png|800px]]

The following is a list of possible replacement variables that can be used to send information from Offerit to your Affiliate's custom pixel or postback URL.
* ''%%aff_id%%'' - Your affiliate ID.
* ''%%offer_id%%'' - The ID of the offer.
* ''%%aff_campaign%%'' - The ID of the campaign/subid used.
* ''%%aff_subid%%'' - The name of the campaign/subid used.
* ''%%ref_url%%'' - The Referring URL for the event being reported
* ''%%transaction_hash%%'' - The transaction ID of the conversion.
* ''%%commission%%'' - The commission related to the conversion.
* ''%%decimal_commission%%'' - The commission related to the conversion in decimal format.
* ''%%aff_approved%%'' - Your auto-pending status.
* ''%%orderid%%'' - The transaction identifier from the advertiser.
* ''%%country_code%%'' - The 2-letter ISO Country code for the surfer
* ''%%cust_custom1%%''- Customer Custom1 Field
* ''%%cust_custom2%%''- Customer Custom2 Field
* ''%%cust_custom3%%''- Customer Custom3 Field
* ''%%cust_custom4%%''- Customer Custom4 Field
* ''%%cust_custom5%%''- Customer Custom5 Field
* ''%%cust_username%%'' - Customer Username
* ''%%cust_email%%'' - Customer Email
* ''%%cust_name%%'' - Customer First and Last Name
* ''%%cust_ip%%'' - The customer record's IP address in IPv4 format
* ''%%cust_ip_long%%'' - The customer record's IP address converted from IPv4 to a long integer using PHP's "ip2long" function
* ''%%subaff%%'' - Subaff Field
* ''%%subaff2%%'' - Subaff2 Field
* ''%%subaff3%%'' - Subaff3 Field
* ''%%subaff4%%'' - Subaff4 Field
* ''%%subaff5%%'' - Subaff5 Field
* ''%%device_type_name%%'' - Device type name
* ''%%device_brand_name%%'' - Device brand name
* ''%%device_browser_name%%'' - Device browser name
* ''%%device_carrier_name%%'' - Device carrier name
* ''%%device_model_name%%'' - Device model name
* ''%%device_os_name%%'' - Device OS name
* ''%%device_os_version_name%%'' - Device OS version
* ''%%_ocid%%'' - The affiliate's external click ID. To use this on postbacks, they must add "&_ocid=<external_clickid>" to their tracking links where <external_clickid> gets replaced with their own click ID.

=== Network Revenue Replacements ===
If you need to send your affiliates the amount your network made on an event in addition to the amount they are being paid, we have a configuration that can be enabled to make this data available for their use. In the Configuration Admin, click the "Affiliates" section in the left side navigation. On this page, scroll down to the "Postbacks" sub section and find "Include Network Revenue on Affiliate Postbacks". This will allow your affiliates to use either of the following replacement variables in their custom pixels/postbacks:
* ''%%network_revenue%%'' - The transaction amount for the event.
* ''%%decimal_network_revenue%%'' - The transaction amount for the event in decimal format.

=== Custom Replacement Variables ===
Offerit allows affiliates to pass custom parameters through their tracking links to your landing pages. For convenience, we make the data passed through available to them for their Custom Pixels and Postbacks as described here:
http://wiki.offerit.com/index.php/Affiliate_Custom_Pixels#Custom_Conversion_Variables. These parameters are also available for replacement in your landing page urls.

=== Special Replacement Syntax ===
Offerit supports several special modifiers that you can include in your replacements.
* ''|default:'' - Allows you to specify the value to return if the requested replacment variable is empty. Without setting this, an empty variable will be replaced with the name of the replacement variable.
** ''email=%%cust_email%%'' will return ''email=cust_email'' if there isn't one.
** ''email=%%cust_email|default:none'' will return ''email=none'' if there isn't one

* ''if|replacement=match:output'' - Allows you to display customized output for matching conditions
** ''device=%%device_type_name%% will return ''device=Desktop''
** ''device=%%if|device_type_name=Desktop:1'' will return ''device=1''

* ''|transform:'' - Allows you to either md5 or base64 encode the data after replacing it.
** ''publisher=%%aff_username%%'' will return ''publisher=somepub123'' if somepub123 is the username of the affiliate.
** ''publisher=%%aff_username|transform:md5%%'' will return ''publisher=155E3C2B7D2E5950C7E5AA70FA71B577'' if somepub123 is the username of the affiliate.
** ''publisher=%%aff_username|transform:base64%%'' will return ''publisher=c29tZXB1YjEyMw=='' if somepub123 is the username of the affiliate.

Template:Offerit Manual

2022-09-13T19:04:31Z

Offeritnick:

{| class="offeritnavbox"
! [[Offerit|Offerit]]
{| class="mw-collapsible {{{show_for_affiliates_section|mw-collapsed}}}" width="100%"
! class="i1" | For Affiliates
|-
| [[Automatic SubIDs]]
|-
| [[Affiliate Stats Dumps|Affiliate Stats Dumps]]
|-
| [[Linkcode|Linkcode]]
|-
| [[Link Groups|Link Groups]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Host and Post]]

|}
{| class="mw-collapsible {{{show_affiliate_area_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Affiliate Area
|-

| [[Affiliate Account Details]]
|-
| [[Affiliate Account Change Log]]
|-
| [[Offerit Affiliate Creatives|Affiliate Creatives]]
|-
| [[Affiliate Creatives Search]]
|-
| [[Affiliate Settings]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Linkcodes]]
|-
| [[Affiliate Linkcode Settings]]
|-
| [[Affiliate Login History]]
|-
| [[Affiliate Messages]]
|-
| [[Affiliate Dashboard]]
|-
| [[Affiliate Dashboard Key Statistics|Dashboard Key Statistics]]
|-
| [[Affiliate Dashboard Statistics Summary|Dashboard Statistics Summary]]
|-
| [[Affiliate Payment History]]
|-
| [[Quick Links]]
|-
| [[Affiliate Referrals Report]]
|-
| [[Affiliate Referring URL Report]]
|-
| [[Affiliate Remote Login]]
|-
| [[Affiliate Signup]]
|-
| [[Affiliate Statistic Filters]]
|-
| [[Affiliate Statistic Views]]
|-
| [[Affiliate SubIDs]]



|}
{| class="mw-collapsible {{{show_setup_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Setup

|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[Tracking Domain]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]
|-
| [[Getting Started Admin]]
|-
| [[Offerit Quick-Start Guide]]
|-
| [[Tracking in Offerit]]
|-
| [[Pixel Builder]]
|-
| [[Offerit Postback Examples]]
|-
| [[Replacement Variables]]
|-
| [[Offerit Currency Exchange Rates|Currency Exchange Rates]]
|}
<hr />
{| class="mw-collapsible {{{show_admin_overview_section|mw-collapsed}}}" width="100%"
! class="i1" | Admin Dashboard
|-
| [[Admin Dashboard|The Admin Dashboard]]
|}
{| class="mw-collapsible {{{show_reporting_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Reporting Admin
|-
| [[Reporting Admin|The Reporting Admin]]
|-
| [[Track and Strack|Track and Strack]]
|-

|}
{| class="mw-collapsible {{{show_report_breakdowns_section|mw-collapsed}}}" width="100%"
! class="i1" |   Report Breakdowns
|-
| [[Profit and Loss Report|Profit and Loss Report]]
|-
| [[Subscription Report|Subscription Report]]
|-
| [[Transactions Report|Transactions Reports]]

|-
| [[Affiliate Ratios Report|Affiliate Ratios Report]]
|-
| [[Affiliate Managers Report]]
|-
| [[Surfer Actions Report|Visitor Actions Report]]
|-
| [[Affiliate Referral Tier Commissions Report|Referral Tier Payouts Report]]
|-
| [[Affiliate Referral Signup Commissions Report|Referral Signup Payouts Report]]
|-
| [[Additional Commissions Report|Additional Commissions Report]]
|-
| [[Graphical Affiliate Comparison Report|Graphical Affiliate Comparison Report]]
|-
| [[Single Day Comparison Report|The Single Day Comparison Report]]
|-
| [[Actual Affiliate Payments|Actual Affiliate Payments Report]]

|}
{| class="mw-collapsible {{{show_offers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Offers Admin
|-
| [[Offers Admin|The Offers Admin]]
|-
| [[Offers|Offers]]
|-
| [[Offer Setup]]
|-
| [[Affiliate Referrals]]
|-
| [[Tracking Domain]]
|-
| [[Offerit Commission|Commissions]]
|-
| [[Commission Changes]]
|-
| [[Suppression Lists]]
|-
| [[Pixel Builder]]

|-
| [[ID Numbers]]
|-
| [[Offer Partner]]

|-
| [[Offer/Landing Page Redirection]]
|-
| [[Offerit Rules|Setting Rules]]
|-
| [[Admin Host and Post]]
|-
| [[Offer Post URLs]]
|-
| [[Offer Goals]]
|}
{| class="mw-collapsible {{{show_affiliates_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Affiliates Admin
|-
| [[Affiliates Admin|The Affiliates Admin]]
|-
| [[ID Numbers]]
|-
| [[Affiliate Managers]]
|-
| [[Affiliate Referrals]]
|-
| [[Offerit Affiliate Activation|Affiliate Activation]]
|-
| [[Admin-Only Settings]]
|-
| [[Offerit Affiliate Override|Affiliate Overrides]]
|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[In House Accounts|In-House Accounts]]
|-
| [[Add Manual Sale]]
|-
| [[Offerit Manual Invoice|Manual Invoice]]
|-
| [[Offerit Affiliate Documents|Affiliate Documents]]
|-
| [[Affiliate Enabled Offers]]
|-
| [[Change Affiliate Status]]
|-
| [[Account Changes]]
|-
|}
{| class="mw-collapsible {{{show_advertisers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Advertisers Admin
|-
| [[Advertisers Admin|The Advertisers Admin]]
|-
| [[Account Changes]]
|-
| [[Advertiser Invoices]]
|-
| [[Generate Invoice]]
|-
| [[Advertiser Approval]]
|-
| [[Change Advertiser Status]]
|}
{| class="mw-collapsible {{{show_customers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Customers Admin
|-
| [[Customers Admin]]
|-
| [[Offerit Add Customer|Manually Adding a Customer]]
|-
| [[ID Numbers]]
|-
|}

{| class="mw-collapsible {{{show_payments_admin_section|mw-collapsed}}}" width="100%"
! class="i1" |Payments Admin
|-
| [[Payments Admin|The Payments Admin]]
|-
| [[Payvia Types]]
|-
| [[Payout Periods]]
|-
| [[Payvia Dump Formats]]
|-
| [[Payment Dump Entry Numbers |Payment Dump Entry Numbers]]
|-
| [[Offerit Payment Dump Variables|Payment Dump Variables]]
|-
| [[Offerit Check Functions|Check Functions]]
|-
| [[Offerit Rules|Setting Rules]]
|}
{| class="mw-collapsible {{{show_payment_methods_section|mw-collapsed}}}" width="100%"
! class="i1" |Payment Methods
|-
| [[Payza|Payza]]
|}
{| class="mw-collapsible {{{show_creatives_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Creatives Admin
|-
| [[Creatives Admin|The Creatives Admin]]

|-
| [[Offerit Add New Creatives|Add New Creatives]]
|-
| [[Offerit Add New Creative Type|Add New Creative Type]]
|-
| [[Offeritcode]]

|-
| [[Code Builder]]
|-
| [[Track and Strack]]
|-
| [[Offerit Rules|Setting Rules]]
|-
|}
{| class="mw-collapsible {{{show_creative_types_section|mw-collapsed}}}" width="100%"
! class="i1" |   Default Creative Types
|-
| [[Creative Types]]
|-
| [[Offerit Image Banners|Image Banners]]
|-
| [[Offerit Flash Banners|Flash Banners]]
|-
| [[Offerit Dynamic Text Banners|Dynamic Text Banners]]
|-
| [[Offerit Feeds|Feeds]]
|-
| [[Offerit Mailers|Mailers]]
|-
| [[Offerit Downloadable Videos|Video Download]]
|-
| [[Offerit Embedded Videos|Video Embed]]
|-
| [[Offerit Page Peels|Page Peels]]
|-
| [[Offerit IM Popups|IM Popups]]
|-
| [[Offerit Footer Ads|Footer Ads]]
|-
| [[Offerit Page Ads|Page Ads]]
|-
| [[Offerit Overlays|Overlays]]
|-
|}

{| class="mw-collapsible {{{show_communications_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Communications Admin
|-
| [[Communications Admin|The Communications Admin]]
|-
| [[Offerit Add News|Add News Item]]
|-
| [[Offerit Send Message|Sending Messages]]
|-
| [[Signup Questions]]

|}
{| class="mw-collapsible {{{show_configuration_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Configuration Admin
|-
| [[Configuration Admin|The Configuration Admin]]

|-
| [[Offerit Affiliate Signup Postback URL|Affiliate Signup Postback URL]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]

|}

{| class="mw-collapsible {{{show_rest_api_section|mw-collapsed}}}" width="100%"
! class="i1" | REST API
|-
! class="i1" | General
|-
| [[Offerit REST API Overview]]
|-
| [[Offerit REST API Ping|GET /service/ping]]
|-
| [[Offerit REST API Set Currency Exchange Rates|PATCH /service/set_currency_exchange_rates]]
|-
! class="i1" | Advertiser
|-
| [[Offerit REST API Edit Advertiser |PATCH /advertiser/edit_advertiser]]
|-
| [[Offerit REST API Add Advertiser |POST /advertiser/add_advertiser]]
|-
! class="i1" | Affiliate
|-
| [[Offerit REST API Get Links |GET /affiliate/get_links]]
|-
| [[Offerit REST API Get Single Link |GET /affiliate/get_single_link]]
|-
| [[Offerit REST API Search_Affiliate|GET /affiliate/search]]
|-
| [[Offerit REST API Decode Trackingcode|GET /affiliate/decode_trackingcode]]
|-
| [[Offerit REST API Edit Affiliate |PATCH /affiliate/edit_affiliate]]
|-
| [[Offerit REST API Set Affiliate Payvia Info|PATCH /affiliate/payvia]]
|-
| [[Offerit REST API Add Affiliate|POST /affiliate/add_affiliate]]
|-
| [[Offerit REST API Affiliate Login Ips|POST /affiliate/affiliate_login_ips]]
|-
! class="i1" | Config
|-
| [[Offerit REST API Get Global Void Ips |GET /config/get_global_void_ips]]
|-
| [[Offerit REST API Get Global Post Ips |GET /config/get_global_post_ips]]
|-
| [[Offerit REST API Get Global Host and Post Ips |GET /config/get_global_hostnpost_ips]]
|-
| [[Offerit REST API Add Global Void Ip |POST /config/add_global_void_ip]]
|-
| [[Offerit REST API Remove Global Void Ip |POST /config/remove_global_void_ip]]
|-
| [[Offerit REST API Add Global Post Ip |POST /config/add_global_post_ip]]
|-
| [[Offerit REST API Remove Global Post Ip |POST /config/remove_global_post_ip]]
|-
| [[Offerit REST API Add Global Host and Post Ips |POST /config/add_global_hostnpost_ip]]
|-
| [[Offerit REST API Remove Global Host and Post Ips |POST /config/remove_global_hostnpost_ip]]
|-
|-
! class="i1" | Creative
|-
| [[Offerit REST API Get Creatives |GET /creative/get_creatives]]
|-
| [[Offerit REST API Get Creatives Fields|GET /creative/get_creative_fields]]
|-
| [[Offerit REST API Get Creatives Rules|GET /creative/get_creative_rules]]
|-
| [[Offerit REST API Delete Creative|PATCH /creative/delete_creative]]
|-
| [[Offerit REST API Edit Creative|PATCH /creative/edit_creative]]
|-
| [[Offerit REST API Edit Creative Rules|PATCH /creative/edit_creative_rules]]
|-
| [[Offerit REST API Undelete Creative|PATCH /creative/undelete_creative]]
|-
| [[Offerit REST API Add Creative|POST /creative/add_creative]]
|-
| [[Offerit REST API Add Creative Rule|POST /creative/add_creative_rule]]
|-
| [[Offerit REST API Delete Creative Rules|POST /creative/delete_creative_rules]]
|-
! class="i1" | Customer
|-
| [[Offerit REST API Set Customer Details|PATCH /customer/set_customer_details]]
|-
| [[Offerit REST API Lock Customer|PATCH /customer/lock]]
|-
| [[Offerit REST API Unlock Customer|PATCH /customer/unlock]]
|-
| [[Offerit REST API Forget Customer|PATCH /customer/forget]]
|-
| [[Offerit REST API Export Customer|GET /customer/export]]
|-
! class="i1" | Offer
|-
| [[Offerit REST API Get Conversion Caps|GET /offer/get_conversion_caps]]
|-
| [[Offerit REST API Check Orderid Exists|GET /offer/check_orderid_exists]]
|-
| [[Offerit REST API Get Commission Changes|GET /offer/get_commission_changes]]
|-
| [[Offerit REST API Offer Get Details|GET /offer/get_details]]
|-
| [[Offerit REST API Activate Offer|PATCH /offer/activate_offer]]
|-
| [[Offerit REST API Edit Landing Page |PATCH /offer/edit_landing_page]]
|-
| [[Offerit REST API Edit Offer |PATCH /offer/edit_offer]]
|-
| [[Offerit REST API Pause Offer|PATCH /offer/pause_offer]]
|-
| [[Offerit REST API Set Commission Change Payouts|PATCH /offer/set_commission_change_payouts]]
|-
| [[Offerit REST API Set Enabled Affiliates |PATCH /offer/set_enabled_affiliates]]
|-
| [[Offerit REST API Set Offer Categories|PATCH /offer/set_offer_categories]]
|-
| [[Offerit REST API Set Offer Countries|PATCH /offer/set_offer_countries]]
|-
| [[Offerit REST API Set Offer Goals |PATCH /offer/set_offer_goals]]
|-
| [[Offerit REST API Set Offer Groups |PATCH /offer/set_offer_groups]]
|-
| [[Offerit REST API Set Offer Marketing Types|PATCH /offer/set_offer_marketing_types]]
|-
| [[Offerit REST API Store Offer Ips|PATCH /offer/store_offer_ips]]
|-
| [[Offerit REST API Add Commission Change |POST /offer/add_commission_change]]
|-
| [[Offerit REST API Add Landing Page |POST /offer/add_landing_page]]
|-
| [[Offerit REST API Add Offer |POST /offer/add_offer]]
|-
| [[Offerit REST API Add Tracking Domain |POST /offer/add_tracking_domain]]
|-
! class="i1" | Reporting
|-
| [[Offerit REST API Get Profit Loss Report|GET /report/profitloss]]
|-
| [[Offerit REST API Get Transaction Report|GET /report/transaction]]
|-
! class="i1" | Transaction
|-
| [[Offerit REST API Get Transaction Payout Preview|GET /transaction/transaction_payout_preview]]
|-
| [[Offerit REST API Transaction Update Revenue By Orderid |PATCH /transaction/transaction_update_revenue_by_orderid]]
|-
| [[Offerit REST API Transaction Update Revenue By Transaction Hash |PATCH /transaction/transaction_update_revenue_by_transaction_hash]]
|-
| [[Offerit REST API Process Void |POST /transaction/process_void]]
|-
| [[Offerit REST API Process Chargeback |POST /transaction/process_chargeback]]
|-
| [[Offerit REST API Process Reversal |POST /transaction/process_reversal]]
|-
| [[Offerit REST API Approve Pending Transaction |POST /transaction/approve_pending_transaction]]
|-
| [[Offerit REST API Click Detail |GET /transaction/click_detail]]
|}
{| class="mw-collapsible {{{show_api_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | SOAP API (*deprecated*)
|-
| [[Offerit API|API]]
|-
| [[Offerit API Add Affiliate|Add Affiliate]]
|-
| [[Offerit API Add Affiliate Sale|Add Affiliate Sale]]
|-
| [[Offerit API Add Offer|Add Offer]]
|-
| [[Offerit API Approve Transaction|Approve Transaction]]

|-
| [[Offerit API Creative Types|Creative Types]]
|-
| [[Offerit API Decode Offeritcode|Decode Offeritcode]]
|-
| [[Offerit API Deny Transaction|Deny Transaction]]
|-
| [[Offerit API Disable Affiliate Landing Page|Disable Affiliate Landing Page]]
|-
| [[Offerit API Edit Affiliate Sale|Edit Affiliate Sale]]
|-
| [[Offerit API Enable Affiliate Landing Page|Enable Affiliate Landing Page]]

|-
| [[Offerit API Get Affiliate Stats|Get Affiliate Stats]]
|-
| [[Offerit API Get Allowed Affiliates|Get Allowed Affiliates]]
|-
| [[Offerit API Get Landing Page Details|Get Landing Page Details]]
|-
| [[Offerit API Get Offer Details|Get Offer Details]]
|-
| [[Offerit API Get Offer List|Get Offer List]]
|-
| [[Offerit API Get Profit Loss Report|Get Profit Loss Report]]

|-
| [[Offerit API List Affiliate Details|List Affiliate Details]]
|-
| [[Offerit API List Affiliate Subaffiliates|List Affiliate Subaffiliates]]
|-
| [[Offerit API Ping|Ping]]
|-

|-
| [[Offerit API Set Affiliate Status|Set Affiliate Status]]

|-
| [[Offerit API Set Subaffiliate Status|Set SubAffiliate Status]]

|-
| [[Offerit API Set Member Details|Set Member Details]]
|-
| [[Offerit API Record Affiliate Click|Record Affiliate Click]]
|}
{| class="mw-collapsible {{{show_misc_section|mw-collapsed}}}" width="100%"
! class="i1" | Misc.
|-
| [[Offerit Rules|Rules]]
|-
| [[Offerit Freeform Date|Freeform Date]]
|-

| [[Affiliate Custom Signup]]
|-
| [[Offeritcode]]
|-
| [[Tracking in Offerit]]
|-
| [[Offerit Logos]]
|-
| [[Void Conversions Remotely]]
|-
|}
<hr />


|}<includeonly>[[Category:Offerit]]</includeonly>

Template:Offerit Manual

2022-09-13T19:04:01Z

Offeritnick:

{| class="offeritnavbox"
! [[Offerit|Offerit]]
{| class="mw-collapsible {{{show_for_affiliates_section|mw-collapsed}}}" width="100%"
! class="i1" | For Affiliates
|-
| [[Automatic SubIDs]]
|-
| [[Affiliate Stats Dumps|Affiliate Stats Dumps]]
|-
| [[Linkcode|Linkcode]]
|-
| [[Link Groups|Link Groups]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Host and Post]]

|}
{| class="mw-collapsible {{{show_affiliate_area_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Affiliate Area
|-

| [[Affiliate Account Details]]
|-
| [[Affiliate Account Change Log]]
|-
| [[Offerit Affiliate Creatives|Affiliate Creatives]]
|-
| [[Affiliate Creatives Search]]
|-
| [[Affiliate Settings]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Linkcodes]]
|-
| [[Affiliate Linkcode Settings]]
|-
| [[Affiliate Login History]]
|-
| [[Affiliate Messages]]
|-
| [[Affiliate Dashboard]]
|-
| [[Affiliate Dashboard Key Statistics|Dashboard Key Statistics]]
|-
| [[Affiliate Dashboard Statistics Summary|Dashboard Statistics Summary]]
|-
| [[Affiliate Payment History]]
|-
| [[Quick Links]]
|-
| [[Affiliate Referrals Report]]
|-
| [[Affiliate Referring URL Report]]
|-
| [[Affiliate Remote Login]]
|-
| [[Affiliate Signup]]
|-
| [[Affiliate Statistic Filters]]
|-
| [[Affiliate Statistic Views]]
|-
| [[Affiliate SubIDs]]



|}
{| class="mw-collapsible {{{show_setup_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Setup

|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[Tracking Domain]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]
|-
| [[Getting Started Admin]]
|-
| [[Offerit Quick-Start Guide]]
|-
| [[Tracking in Offerit]]
|-
| [[Pixel Builder]]
|-
| [[Offerit Postback Examples]]
|-
| [[Replacement Variables]]
|-
| [[Offerit Currency Exchange Rates|Currency Exchange Rates]]
|}
<hr />
{| class="mw-collapsible {{{show_admin_overview_section|mw-collapsed}}}" width="100%"
! class="i1" | Admin Dashboard
|-
| [[Admin Dashboard|The Admin Dashboard]]
|}
{| class="mw-collapsible {{{show_reporting_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Reporting Admin
|-
| [[Reporting Admin|The Reporting Admin]]
|-
| [[Track and Strack|Track and Strack]]
|-

|}
{| class="mw-collapsible {{{show_report_breakdowns_section|mw-collapsed}}}" width="100%"
! class="i1" |   Report Breakdowns
|-
| [[Profit and Loss Report|Profit and Loss Report]]
|-
| [[Subscription Report|Subscription Report]]
|-
| [[Transactions Report|Transactions Reports]]

|-
| [[Affiliate Ratios Report|Affiliate Ratios Report]]
|-
| [[Affiliate Managers Report]]
|-
| [[Surfer Actions Report|Visitor Actions Report]]
|-
| [[Affiliate Referral Tier Commissions Report|Referral Tier Payouts Report]]
|-
| [[Affiliate Referral Signup Commissions Report|Referral Signup Payouts Report]]
|-
| [[Additional Commissions Report|Additional Commissions Report]]
|-
| [[Graphical Affiliate Comparison Report|Graphical Affiliate Comparison Report]]
|-
| [[Single Day Comparison Report|The Single Day Comparison Report]]
|-
| [[Actual Affiliate Payments|Actual Affiliate Payments Report]]

|}
{| class="mw-collapsible {{{show_offers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Offers Admin
|-
| [[Offers Admin|The Offers Admin]]
|-
| [[Offers|Offers]]
|-
| [[Offer Setup]]
|-
| [[Affiliate Referrals]]
|-
| [[Tracking Domain]]
|-
| [[Offerit Commission|Commissions]]
|-
| [[Commission Changes]]
|-
| [[Suppression Lists]]
|-
| [[Pixel Builder]]

|-
| [[ID Numbers]]
|-
| [[Offer Partner]]

|-
| [[Offer/Landing Page Redirection]]
|-
| [[Offerit Rules|Setting Rules]]
|-
| [[Admin Host and Post]]
|-
| [[Offer Post URLs]]
|-
| [[Offer Goals]]
|}
{| class="mw-collapsible {{{show_affiliates_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Affiliates Admin
|-
| [[Affiliates Admin|The Affiliates Admin]]
|-
| [[ID Numbers]]
|-
| [[Affiliate Managers]]
|-
| [[Affiliate Referrals]]
|-
| [[Offerit Affiliate Activation|Affiliate Activation]]
|-
| [[Admin-Only Settings]]
|-
| [[Offerit Affiliate Override|Affiliate Overrides]]
|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[In House Accounts|In-House Accounts]]
|-
| [[Add Manual Sale]]
|-
| [[Offerit Manual Invoice|Manual Invoice]]
|-
| [[Offerit Affiliate Documents|Affiliate Documents]]
|-
| [[Affiliate Enabled Offers]]
|-
| [[Change Affiliate Status]]
|-
| [[Account Changes]]
|-
|}
{| class="mw-collapsible {{{show_advertisers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Advertisers Admin
|-
| [[Advertisers Admin|The Advertisers Admin]]
|-
| [[Account Changes]]
|-
| [[Advertiser Invoices]]
|-
| [[Generate Invoice]]
|-
| [[Advertiser Approval]]
|-
| [[Change Advertiser Status]]
|}
{| class="mw-collapsible {{{show_customers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Customers Admin
|-
| [[Customers Admin]]
|-
| [[Offerit Add Customer|Manually Adding a Customer]]
|-
| [[ID Numbers]]
|-
|}

{| class="mw-collapsible {{{show_payments_admin_section|mw-collapsed}}}" width="100%"
! class="i1" |Payments Admin
|-
| [[Payments Admin|The Payments Admin]]
|-
| [[Payvia Types]]
|-
| [[Payout Periods]]
|-
| [[Payvia Dump Formats]]
|-
| [[Payment Dump Entry Numbers |Payment Dump Entry Numbers]]
|-
| [[Offerit Payment Dump Variables|Payment Dump Variables]]
|-
| [[Offerit Check Functions|Check Functions]]
|-
| [[Offerit Rules|Setting Rules]]
|}
{| class="mw-collapsible {{{show_payment_methods_section|mw-collapsed}}}" width="100%"
! class="i1" |Payment Methods
|-
| [[Payza|Payza]]
|}
{| class="mw-collapsible {{{show_creatives_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Creatives Admin
|-
| [[Creatives Admin|The Creatives Admin]]

|-
| [[Offerit Add New Creatives|Add New Creatives]]
|-
| [[Offerit Add New Creative Type|Add New Creative Type]]
|-
| [[Offeritcode]]

|-
| [[Code Builder]]
|-
| [[Track and Strack]]
|-
| [[Offerit Rules|Setting Rules]]
|-
|}
{| class="mw-collapsible {{{show_creative_types_section|mw-collapsed}}}" width="100%"
! class="i1" |   Default Creative Types
|-
| [[Creative Types]]
|-
| [[Offerit Image Banners|Image Banners]]
|-
| [[Offerit Flash Banners|Flash Banners]]
|-
| [[Offerit Dynamic Text Banners|Dynamic Text Banners]]
|-
| [[Offerit Feeds|Feeds]]
|-
| [[Offerit Mailers|Mailers]]
|-
| [[Offerit Downloadable Videos|Video Download]]
|-
| [[Offerit Embedded Videos|Video Embed]]
|-
| [[Offerit Page Peels|Page Peels]]
|-
| [[Offerit IM Popups|IM Popups]]
|-
| [[Offerit Footer Ads|Footer Ads]]
|-
| [[Offerit Page Ads|Page Ads]]
|-
| [[Offerit Overlays|Overlays]]
|-
|}

{| class="mw-collapsible {{{show_communications_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Communications Admin
|-
| [[Communications Admin|The Communications Admin]]
|-
| [[Offerit Add News|Add News Item]]
|-
| [[Offerit Send Message|Sending Messages]]
|-
| [[Signup Questions]]

|}
{| class="mw-collapsible {{{show_configuration_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Configuration Admin
|-
| [[Configuration Admin|The Configuration Admin]]

|-
| [[Offerit Affiliate Signup Postback URL|Affiliate Signup Postback URL]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]

|}

{| class="mw-collapsible {{{show_rest_api_section|mw-collapsed}}}" width="100%"
! class="i1" | REST API
|-
! class="i1" | General
|-
| [[Offerit REST API Overview]]
|-
| [[Offerit REST API Ping|GET /service/ping]]
|-
| [[Offerit REST API Set Currency Exchange Rates|PATCH /service/set_currency_exchange_rates]]
|-
! class="i1" | Advertiser
|-
| [[Offerit REST API Edit Advertiser |PATCH /advertiser/edit_advertiser]]
|-
| [[Offerit REST API Add Advertiser |POST /advertiser/add_advertiser]]
|-
! class="i1" | Affiliate
|-
| [[Offerit REST API Get Links |GET /affiliate/get_links]]
|-
| [[Offerit REST API Get Single Link |GET /affiliate/get_single_link]]
|-
| [[Offerit REST API Search_Affiliate|GET /affiliate/search]]
|-
| [[Offerit REST API Decode Trackingcode|GET /affiliate/decode_trackingcode]]
|-
| [[Offerit REST API Edit Affiliate |PATCH /affiliate/edit_affiliate]]
|-
| [[Offerit REST API Set Affiliate Payvia Info|PATCH /affiliate/payvia]]
|-
| [[Offerit REST API Add Affiliate|POST /affiliate/add_affiliate]]
|-
| [[Offerit REST API Affiliate Login Ips|POST /affiliate/affiliate_login_ips]]

! class="i1" | Config
|-
| [[Offerit REST API Get Global Void Ips |GET /config/get_global_void_ips]]
|-
| [[Offerit REST API Get Global Post Ips |GET /config/get_global_post_ips]]
|-
| [[Offerit REST API Get Global Host and Post Ips |GET /config/get_global_hostnpost_ips]]
|-
| [[Offerit REST API Add Global Void Ip |POST /config/add_global_void_ip]]
|-
| [[Offerit REST API Remove Global Void Ip |POST /config/remove_global_void_ip]]
|-
| [[Offerit REST API Add Global Post Ip |POST /config/add_global_post_ip]]
|-
| [[Offerit REST API Remove Global Post Ip |POST /config/remove_global_post_ip]]
|-
| [[Offerit REST API Add Global Host and Post Ips |POST /config/add_global_hostnpost_ip]]
|-
| [[Offerit REST API Remove Global Host and Post Ips |POST /config/remove_global_hostnpost_ip]]
|-
|-
! class="i1" | Creative
|-
| [[Offerit REST API Get Creatives |GET /creative/get_creatives]]
|-
| [[Offerit REST API Get Creatives Fields|GET /creative/get_creative_fields]]
|-
| [[Offerit REST API Get Creatives Rules|GET /creative/get_creative_rules]]
|-
| [[Offerit REST API Delete Creative|PATCH /creative/delete_creative]]
|-
| [[Offerit REST API Edit Creative|PATCH /creative/edit_creative]]
|-
| [[Offerit REST API Edit Creative Rules|PATCH /creative/edit_creative_rules]]
|-
| [[Offerit REST API Undelete Creative|PATCH /creative/undelete_creative]]
|-
| [[Offerit REST API Add Creative|POST /creative/add_creative]]
|-
| [[Offerit REST API Add Creative Rule|POST /creative/add_creative_rule]]
|-
| [[Offerit REST API Delete Creative Rules|POST /creative/delete_creative_rules]]
|-
! class="i1" | Customer
|-
| [[Offerit REST API Set Customer Details|PATCH /customer/set_customer_details]]
|-
| [[Offerit REST API Lock Customer|PATCH /customer/lock]]
|-
| [[Offerit REST API Unlock Customer|PATCH /customer/unlock]]
|-
| [[Offerit REST API Forget Customer|PATCH /customer/forget]]
|-
| [[Offerit REST API Export Customer|GET /customer/export]]
|-
! class="i1" | Offer
|-
| [[Offerit REST API Get Conversion Caps|GET /offer/get_conversion_caps]]
|-
| [[Offerit REST API Check Orderid Exists|GET /offer/check_orderid_exists]]
|-
| [[Offerit REST API Get Commission Changes|GET /offer/get_commission_changes]]
|-
| [[Offerit REST API Offer Get Details|GET /offer/get_details]]
|-
| [[Offerit REST API Activate Offer|PATCH /offer/activate_offer]]
|-
| [[Offerit REST API Edit Landing Page |PATCH /offer/edit_landing_page]]
|-
| [[Offerit REST API Edit Offer |PATCH /offer/edit_offer]]
|-
| [[Offerit REST API Pause Offer|PATCH /offer/pause_offer]]
|-
| [[Offerit REST API Set Commission Change Payouts|PATCH /offer/set_commission_change_payouts]]
|-
| [[Offerit REST API Set Enabled Affiliates |PATCH /offer/set_enabled_affiliates]]
|-
| [[Offerit REST API Set Offer Categories|PATCH /offer/set_offer_categories]]
|-
| [[Offerit REST API Set Offer Countries|PATCH /offer/set_offer_countries]]
|-
| [[Offerit REST API Set Offer Goals |PATCH /offer/set_offer_goals]]
|-
| [[Offerit REST API Set Offer Groups |PATCH /offer/set_offer_groups]]
|-
| [[Offerit REST API Set Offer Marketing Types|PATCH /offer/set_offer_marketing_types]]
|-
| [[Offerit REST API Store Offer Ips|PATCH /offer/store_offer_ips]]
|-
| [[Offerit REST API Add Commission Change |POST /offer/add_commission_change]]
|-
| [[Offerit REST API Add Landing Page |POST /offer/add_landing_page]]
|-
| [[Offerit REST API Add Offer |POST /offer/add_offer]]
|-
| [[Offerit REST API Add Tracking Domain |POST /offer/add_tracking_domain]]
|-
! class="i1" | Reporting
|-
| [[Offerit REST API Get Profit Loss Report|GET /report/profitloss]]
|-
| [[Offerit REST API Get Transaction Report|GET /report/transaction]]
|-
! class="i1" | Transaction
|-
| [[Offerit REST API Get Transaction Payout Preview|GET /transaction/transaction_payout_preview]]
|-
| [[Offerit REST API Transaction Update Revenue By Orderid |PATCH /transaction/transaction_update_revenue_by_orderid]]
|-
| [[Offerit REST API Transaction Update Revenue By Transaction Hash |PATCH /transaction/transaction_update_revenue_by_transaction_hash]]
|-
| [[Offerit REST API Process Void |POST /transaction/process_void]]
|-
| [[Offerit REST API Process Chargeback |POST /transaction/process_chargeback]]
|-
| [[Offerit REST API Process Reversal |POST /transaction/process_reversal]]
|-
| [[Offerit REST API Approve Pending Transaction |POST /transaction/approve_pending_transaction]]
|-
| [[Offerit REST API Click Detail |GET /transaction/click_detail]]
|}
{| class="mw-collapsible {{{show_api_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | SOAP API (*deprecated*)
|-
| [[Offerit API|API]]
|-
| [[Offerit API Add Affiliate|Add Affiliate]]
|-
| [[Offerit API Add Affiliate Sale|Add Affiliate Sale]]
|-
| [[Offerit API Add Offer|Add Offer]]
|-
| [[Offerit API Approve Transaction|Approve Transaction]]

|-
| [[Offerit API Creative Types|Creative Types]]
|-
| [[Offerit API Decode Offeritcode|Decode Offeritcode]]
|-
| [[Offerit API Deny Transaction|Deny Transaction]]
|-
| [[Offerit API Disable Affiliate Landing Page|Disable Affiliate Landing Page]]
|-
| [[Offerit API Edit Affiliate Sale|Edit Affiliate Sale]]
|-
| [[Offerit API Enable Affiliate Landing Page|Enable Affiliate Landing Page]]

|-
| [[Offerit API Get Affiliate Stats|Get Affiliate Stats]]
|-
| [[Offerit API Get Allowed Affiliates|Get Allowed Affiliates]]
|-
| [[Offerit API Get Landing Page Details|Get Landing Page Details]]
|-
| [[Offerit API Get Offer Details|Get Offer Details]]
|-
| [[Offerit API Get Offer List|Get Offer List]]
|-
| [[Offerit API Get Profit Loss Report|Get Profit Loss Report]]

|-
| [[Offerit API List Affiliate Details|List Affiliate Details]]
|-
| [[Offerit API List Affiliate Subaffiliates|List Affiliate Subaffiliates]]
|-
| [[Offerit API Ping|Ping]]
|-

|-
| [[Offerit API Set Affiliate Status|Set Affiliate Status]]

|-
| [[Offerit API Set Subaffiliate Status|Set SubAffiliate Status]]

|-
| [[Offerit API Set Member Details|Set Member Details]]
|-
| [[Offerit API Record Affiliate Click|Record Affiliate Click]]
|}
{| class="mw-collapsible {{{show_misc_section|mw-collapsed}}}" width="100%"
! class="i1" | Misc.
|-
| [[Offerit Rules|Rules]]
|-
| [[Offerit Freeform Date|Freeform Date]]
|-

| [[Affiliate Custom Signup]]
|-
| [[Offeritcode]]
|-
| [[Tracking in Offerit]]
|-
| [[Offerit Logos]]
|-
| [[Void Conversions Remotely]]
|-
|}
<hr />


|}<includeonly>[[Category:Offerit]]</includeonly>

Offerit REST API Add Affiliate

2022-09-13T18:52:08Z

Offeritnick: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /affiliate/addaffiliate''' ==
'''Description'''
*To add an affiliate through the [[Offerit]] API, you can make a call to this api endpoint.

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/addaffiliate</nowiki>
*Replace domain with the offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*POST

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

*username
**'''''type: string'''''
**'''''required'''
*password
**'''''type: string'''''
**'''''required'''
*payvia
**'''''type: string'''''
**'''''required'''
*payvia_info
**'''''type: array'''''
**'''''an array containing field/value pair arrays of payvia information to set for the affiliate'''''
**'''''Must send "payvia" parameter to indicate which payvia type payvia_info is for.'''''
*email
**'''''type: string'''''
**'''''required'''
*firstname
**'''''type: string'''''
*lastname
**'''''type: string'''''
*company
**'''''type: string'''''
*url
**'''''type: string'''''
*tel
**'''''type: string'''''
*icq
**'''''type: string'''''
*aim
**'''''type: string'''''
*msn
**'''''type: string'''''
*skype
**'''''type: string'''''
*address1
**'''''type: string'''''
*address2
**'''''type: string'''''
*city
**'''''type: string'''''
*state
**'''''type: string'''''
*country
**'''''type: string'''''
*zip_code
**'''''type: string'''''
*tax_id_or_ssn
**'''''type: string'''''
*ref
**'''''type: string'''''
*minimum_payout
**'''''type: string'''''
*join_ip
**'''''type: string'''''
*custom1
**'''''type: string'''''
**'''''max 255 characters'''
*custom2
**'''''type: string'''''
**'''''max 255 characters'''
*custom3
**'''''type: string'''''
**'''''max 255 characters'''
*custom4
**'''''type: string'''''
**'''''max 255 characters'''
*custom5
**'''''type: string'''''
**'''''max 255 characters'''
*status
**'''''type: int'''''
**'''''Possible values: 0 - Active, 1 - Disabled, 2 - Banned, 3 - Wait on Verify, 4 - Pending, 5 - Denied'''

== '''Example Request''' ==

'''POST'''
<pre>
<nowiki>
http://domain/api/affiliate/add_affiliate
username = hello
password = apitest
firstname = hello
lastname = test
email = hello@offerit.com
company = Offerit
url = offerit.com
tel = 666-666-6666
icq = 666666666
aim = sixsixsix
msn = sixsixtysix
address1 = 666 666 st
address2 =
city = My City
state = My State
country = USA
zip_code = 12345
tax_id_or_ssn = 54-1233245
ref = asdasd
minimum_payout = 50
join_ip = 192.168.1.1
payvia=1
</nowiki>
</pre>
*Response:
<pre>
[
{
"result": true,
"loginid": "10"
}
]
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = array(
'username' => 'hello',
'password' => 'apitest',
'firstname' => 'hello',
'lastname' => 'test',
'email' => 'hello@offerit.com',
'company' => 'Offerit',
'url' => 'offerit.com',
'tel' => '666-666-6666',
'icq' => '666666666',
'aim' => 'sixsixsix',
'msn' => 'sixsixtysix',
'address1' => '666 666 st',
'address2' => '',
'city' => 'My City',
'state' => 'My State',
'country' => 'USA',
'zip_code' => '12345',
'tax_id_or_ssn' => '54-1233245',
'ref' => 'asdasd',
'minimum_payout' => 50,
'join_ip' => '192.168.1.1',
'payvia' => '1', // Check payvia type
// notice the structure is an array of sub-arrays that have field/value pairs
'payvia_info' => Array(
Array(
'field' => 'Pay To',
'value' => 'Affiliate PayTo Name',
),
Array(
'field' => 'Address',
'value' => 'Affiliate Address',
),
),
);

$url = 'http://domain/api/affiliate/addaffiliate';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

?>

</pre>

[[Category:Offerit API Articles]]

Offerit REST API Add Affiliate

2022-09-13T18:51:46Z

Offeritnick: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /affiliate/addaffiliate''' ==
'''Description'''
*To add an affiliate through the [[Offerit]] API, you can make a call to this api endpoint.

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/addaffiliate</nowiki>
*Replace domain with the offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*POST

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

*username
**'''''type: string'''''
**'''''required'''
*password
**'''''type: string'''''
**'''''required'''
*payvia
**'''''type: string'''''
**'''''required'''
*payvia_info
**'''''type: array'''''
**'''''an array containing field/value pair arrays of payvia information to set for the affiliate'''''
**'''''Must send "payvia" parameter to indicate which payvia type payvia_info is for.'''''
*email
**'''''type: string'''''
**'''''required'''
*firstname
**'''''type: string'''''
*lastname
**'''''type: string'''''
*company
**'''''type: string'''''
*url
**'''''type: string'''''
*tel
**'''''type: string'''''
*icq
**'''''type: string'''''
*aim
**'''''type: string'''''
*msn
**'''''type: string'''''
*skype
**'''''type: string'''''
*address1
**'''''type: string'''''
*address2
**'''''type: string'''''
*city
**'''''type: string'''''
*state
**'''''type: string'''''
*country
**'''''type: string'''''
*zip_code
**'''''type: string'''''
*tax_id_or_ssn
**'''''type: string'''''
*ref
**'''''type: string'''''
*minimum_payout
**'''''type: string'''''
*join_ip
**'''''type: string'''''
*custom1
**'''''type: string'''''
**'''''max 255 characters'''
*custom2
**'''''type: string'''''
**'''''max 255 characters'''
*custom3
**'''''type: string'''''
**'''''max 255 characters'''
*custom4
**'''''type: string'''''
**'''''max 255 characters'''
*custom5
**'''''type: string'''''
**'''''max 255 characters'''
*status
**'''''type: int'''''
**'''''Possible values: 0,1,2,3,4,5'''
**'''''Value meanings: 0 - Active, 1 - Disabled, 2 - Banned, 3 - Wait on Verify, 4 - Pending, 5 - Denied'''

== '''Example Request''' ==

'''POST'''
<pre>
<nowiki>
http://domain/api/affiliate/add_affiliate
username = hello
password = apitest
firstname = hello
lastname = test
email = hello@offerit.com
company = Offerit
url = offerit.com
tel = 666-666-6666
icq = 666666666
aim = sixsixsix
msn = sixsixtysix
address1 = 666 666 st
address2 =
city = My City
state = My State
country = USA
zip_code = 12345
tax_id_or_ssn = 54-1233245
ref = asdasd
minimum_payout = 50
join_ip = 192.168.1.1
payvia=1
</nowiki>
</pre>
*Response:
<pre>
[
{
"result": true,
"loginid": "10"
}
]
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = array(
'username' => 'hello',
'password' => 'apitest',
'firstname' => 'hello',
'lastname' => 'test',
'email' => 'hello@offerit.com',
'company' => 'Offerit',
'url' => 'offerit.com',
'tel' => '666-666-6666',
'icq' => '666666666',
'aim' => 'sixsixsix',
'msn' => 'sixsixtysix',
'address1' => '666 666 st',
'address2' => '',
'city' => 'My City',
'state' => 'My State',
'country' => 'USA',
'zip_code' => '12345',
'tax_id_or_ssn' => '54-1233245',
'ref' => 'asdasd',
'minimum_payout' => 50,
'join_ip' => '192.168.1.1',
'payvia' => '1', // Check payvia type
// notice the structure is an array of sub-arrays that have field/value pairs
'payvia_info' => Array(
Array(
'field' => 'Pay To',
'value' => 'Affiliate PayTo Name',
),
Array(
'field' => 'Address',
'value' => 'Affiliate Address',
),
),
);

$url = 'http://domain/api/affiliate/addaffiliate';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

?>

</pre>

[[Category:Offerit API Articles]]

Offerit REST API Remove Global Post Ip

2022-08-26T19:48:19Z

Offeritnick: /* POST /config/remove_global_post_ip */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /config/remove_global_post_ip''' ==
'''Description'''
*The api/config/remove_global_post_ip action removes a provided ip from the Config -> Security, Global Postback Allowed IPs

'''Resource URL'''
*<nowiki>https://domain/api/config/remove_global_post_ip</nowiki>
*Replace domain with the Offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*POST

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
'''Parameters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

*ip
**'''''type: string'''''
**'''required'''
**ipv4 or ipv6 format

== '''Example Request''' ==

'''POST'''

<nowiki>https://domain/api/config/remove_global_post_ip</nowiki>

*Response:
<pre>
{
"result": "success",
"data": "Ip removed / not in list / list not set"
}

{
"result": "error",
"data": "Invalid ip"
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = array(
'ip' => '73.279.112.30',
);

$url = 'https://domain/api/config/remove_global_post_ip';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Add Creative Rule

2022-08-26T17:00:47Z

Offeritnick: /* POST /creative/add_creative_rule */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /creative/add_creative_rule''' ==
'''Description'''
*add_creative_rule adds a new creative rule

'''Resource URL'''
*<nowiki>http://domain/api/creative/add_creative_rule</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*POST

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*creativeids
**'''''type: integer,string,array'''''
**'''''required'''
**either creativeids for which you are adding rules. accepts int, comma separated list of ints, array of ints.
*rule_type
**'''''type: string'''''
**'''''required'''
**SHOW, HIDE, or IGNORE

*offerids
**'''''type: integer,string,array'''''
**'''''required'''
**offer ids that this rule applies to. accepts int, comma separated list of ints, array of ints.
*landing_pageids
**'''''type: integer,string,array'''''
**'''''required'''
**landing page ids that this rule applies to. accepts int, comma separated list of ints, array of ints.
*loginids
**'''''type: integer,string,array'''''
**'''''required'''
**affiliate login ids that this rule applies to. accepts int, comma separated list of ints, array of ints.
*start_time
**'''''type: string'''''
**'''''optional'''
**we will run stringtotime on this. Default Now
*end_time
**'''''type: string'''''
**'''''optional'''
**we will run stringtotime on this. Default Never

== '''Example Request''' ==

'''POST'''

<nowiki>http://domain/api/creative/add_creative_rule?creativeids=1&offerids=1&rule_type=HIDE</nowiki>

*Response:
<pre>
{
"successes":
{"13":
{
"creativeid": "13",
"ruleid": "57c9b48dee963"
}
},
"failures": [],
"total_successes": 1
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/creative/add_creative_rule'
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$data = Array(
'creativeids' => 1,
'start_time' => 'January 1, 2016',
'offerids' => '1,2,3',
'rule_type' => 'SHOW',
);
$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Edit Creative Rules

2022-08-26T16:37:23Z

Offeritnick: /* PATCH /creative/_creative_rule */

{{Offerit Manual
| show_rest_api_section = true
}}

== '''PATCH /creative/edit_creative_rule''' ==
'''Description'''
*edit_creative_rule expires an existing creative rule and creates a new one.

'''Resource URL'''
*<nowiki>http://domain/api/creative/edit_creative_rule</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*creativeids
**'''''type: integer,string,array'''''
**'''''required'''
**either creativeids for which you are editing rules. accepts int, comma separated list of ints, array of ints.
*ruleid
**'''''type: string'''''
**'''''required'''
**the ruleid that you are editing.
*rule_type
**'''''type: string'''''
**'''''required'''
**SHOW, HIDE, or IGNORE

*offerids
**'''''type: integer,string,array'''''
**'''''required'''
**offer ids that this rule applies to. accepts int, comma separated list of ints, array of ints.
*landing_pageids
**'''''type: integer,string,array'''''
**'''''required'''
**landing page ids that this rule applies to. accepts int, comma separated list of ints, array of ints.
*loginids
**'''''type: integer,string,array'''''
**'''''required'''
**affiliate login ids that this rule applies to. accepts int, comma separated list of ints, array of ints.
*start_time
**'''''type: string'''''
**'''''optional'''
**we will run stringtotime on this. Default Now
*end_time
**'''''type: string'''''
**'''''optional'''
**we will run stringtotime on this. Default Never

== '''Example Request''' ==

'''PATCH'''

<nowiki>http://domain/api/creative/edit_creative_rule?creativeids=1&ruleid=57c737f693a89&offerids=1&rule_type=HIDE</nowiki>

*Response:
<pre>
{
"successes":
{"13":
{
"creativeid": "13",
"original_ruleid": "57c737f693a89",
"new_ruleid": "57c9b48dee963"
}
},
"failures": [],
"total_successes": 1
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/creative/edit_creative_rule'
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$data = Array(
'creativeids' => 1,
'ruleid' => '57c737f693a89',
'start_time' => 'January 1, 2016',
'offerids' => '1,2,3',
'rule_type' => 'SHOW',
);
$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Delete Creative Rules

2022-08-26T16:37:06Z

Offeritnick: /* POST /creative/delete_creative_rule */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /creative/delete_creative_rule''' ==
'''Description'''
*delete_creative_rule deletes creative rules

'''Resource URL'''
*<nowiki>http://domain/api/creative/delete_creative_rule</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*POST

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*creativeids
**'''''type: integer,string,array'''''
**'''''required'''
**creativeids for which you are deleting rules. accepts int, comma separated list of ints, array of ints.
*ruleids
**'''''type: string,array'''''
**'''''required'''
**ruleids to delete. accepts string, comma separated list of strings, array of strings.

== '''Example Request''' ==

'''POST'''

<nowiki>http://domain/api/creative/delete_creative_rule?creativeids=1&ruleids=57c738de72d59</nowiki>

*Response:
<pre>
{
"successes": [
{
"creativeid": "13",
"ruleid": "57c738de72d59"
}
],
"failures": [],
"total_successes": 1
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/creative/delete_creative_rule'
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$data = Array(
'creativeids' => 1,
'ruleids' => '57c738de72d59'
);
$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Add Affiliate

2022-08-18T17:27:16Z

Offeritnick:

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /affiliate/addaffiliate''' ==
'''Description'''
*To add an affiliate through the [[Offerit]] API, you can make a call to this api endpoint.

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/addaffiliate</nowiki>
*Replace domain with the offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*POST

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

*username
**'''''type: string'''''
**'''''required'''
*password
**'''''type: string'''''
**'''''required'''
*payvia
**'''''type: string'''''
**'''''required'''
*payvia_info
**'''''type: array'''''
**'''''an array containing field/value pair arrays of payvia information to set for the affiliate'''''
**'''''Must send "payvia" parameter to indicate which payvia type payvia_info is for.'''''
*email
**'''''type: string'''''
**'''''required'''
*firstname
**'''''type: string'''''
*lastname
**'''''type: string'''''
*company
**'''''type: string'''''
*url
**'''''type: string'''''
*tel
**'''''type: string'''''
*icq
**'''''type: string'''''
*aim
**'''''type: string'''''
*msn
**'''''type: string'''''
*skype
**'''''type: string'''''
*address1
**'''''type: string'''''
*address2
**'''''type: string'''''
*city
**'''''type: string'''''
*state
**'''''type: string'''''
*country
**'''''type: string'''''
*zip_code
**'''''type: string'''''
*tax_id_or_ssn
**'''''type: string'''''
*ref
**'''''type: string'''''
*minimum_payout
**'''''type: string'''''
*join_ip
**'''''type: string'''''
*custom1
**'''''type: string'''''
**'''''max 255 characters'''
*custom2
**'''''type: string'''''
**'''''max 255 characters'''
*custom3
**'''''type: string'''''
**'''''max 255 characters'''
*custom4
**'''''type: string'''''
**'''''max 255 characters'''
*custom5
**'''''type: string'''''
**'''''max 255 characters'''


== '''Example Request''' ==

'''POST'''
<pre>
<nowiki>
http://domain/api/affiliate/add_affiliate
username = hello
password = apitest
firstname = hello
lastname = test
email = hello@offerit.com
company = Offerit
url = offerit.com
tel = 666-666-6666
icq = 666666666
aim = sixsixsix
msn = sixsixtysix
address1 = 666 666 st
address2 =
city = My City
state = My State
country = USA
zip_code = 12345
tax_id_or_ssn = 54-1233245
ref = asdasd
minimum_payout = 50
join_ip = 192.168.1.1
payvia=1
</nowiki>
</pre>
*Response:
<pre>
[
{
"result": true,
"loginid": "10"
}
]
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = array(
'username' => 'hello',
'password' => 'apitest',
'firstname' => 'hello',
'lastname' => 'test',
'email' => 'hello@offerit.com',
'company' => 'Offerit',
'url' => 'offerit.com',
'tel' => '666-666-6666',
'icq' => '666666666',
'aim' => 'sixsixsix',
'msn' => 'sixsixtysix',
'address1' => '666 666 st',
'address2' => '',
'city' => 'My City',
'state' => 'My State',
'country' => 'USA',
'zip_code' => '12345',
'tax_id_or_ssn' => '54-1233245',
'ref' => 'asdasd',
'minimum_payout' => 50,
'join_ip' => '192.168.1.1',
'payvia' => '1', // Check payvia type
// notice the structure is an array of sub-arrays that have field/value pairs
'payvia_info' => Array(
Array(
'field' => 'Pay To',
'value' => 'Affiliate PayTo Name',
),
Array(
'field' => 'Address',
'value' => 'Affiliate Address',
),
),
);

$url = 'http://domain/api/affiliate/addaffiliate';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

?>

</pre>

[[Category:Offerit API Articles]]

Offerit Currency Exchange Rates

2021-08-25T16:14:41Z

Offeritnick: /* Automatic Updates */

{{Offerit Manual|show_setup_section=true}}

Ideally, the amounts reported back to Offerit should be a converted amount to your base currency. However, offerit can be used for converting amounts instead. When sending a postback to offerit for a different currency, we will use the exchange rate configured in your Offerit install at the time we receive the postback/pixel call for a transaction. With these details in mind, here are a few potential issues that can occur when using Offerit for converting currencies:
* The exchange rate used by the processor for the transaction does not match up with the exchange rate configured in offerit when the postback/pixel is received
* The exchange rate our source is reporting does not match the rate you want or expect
* The source api fails to return the latest rates

= Automatic Updates =
By default Offerit updates conversion rates once a day from https://exchangerate.host. We have options to decrease this frequency to weekly if you choose. If you would like to update more frequently than this, you can turn OFF the automatic update configuration and use our [[Offerit_REST_API_Set_Currency_Exchange_Rates|Set Currency Exchange Rates API]] to send exchange rate updates.

== Automatic Update Configurations ==
* Automatic Exchange Rate Updates - Turn automatic updates for currency exchange rates on or off.
* Automatic Update Currency List - You can use a comma separated list if you only want to opt-in to automatic updates for specific currencies.
* Automatic Update Exclude Currency List - You can use a comma separated list if you want to opt-out of automatic updates for specific currencies.
* Automatic Update Schedule - Daily is our default, but you can choose weekly updates on a specific day of the week as well.
* Exchange Rate Source - The source API you would like to receive automatic updates from.
* Open Exchange Rates App ID - If you choose "Open Exchange Rates" as your Exchange Rate Soruce, you can use this to set a personal "App ID" for making the API calls to their system.
* Exchange Rates API Access Key - If you choose "Exchange Rates API" as your Exchange Rate Source, you can use this to set a personal Access Key for making calls to their system

Offerit REST API Edit Affiliate

2021-03-25T16:07:48Z

Offeritnick: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''PATCH /affiliate/edit_affiliate ''' ==
'''Description'''
*edit_affiliate edits an existing affiliate account

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/edit_affiliate</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''Parameters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''
*loginid
**'''''type: string'''''
**'''''required'''''
**Id of affiliate to edit
*password
**'''''type: string'''''
**Affiliate Password
*payvia
**'''''type: int'''''
**Payvia type id of the payvia type to use with this affiliate
*email
**'''''type: string'''''
**'''''unique'''''
**Email address for this affiliate
*status
**'''''type: int'''''
**ID of the account status for this affiliate (0 - Active, 1 - Disabled, 2 - Banned, 3 - Wait on Verify, 4 - Pending, 5 - Denied)
*firstname
**'''''type: string'''''
*lastname
**'''''type: string'''''
*company
**'''''type: string'''''
*url
**'''''type: string'''''
*tel
**'''''type: string'''''
*icq
**'''''type: string'''''
*aim
**'''''type: string'''''
*msn
**'''''type: string'''''
*address1
**'''''type: string'''''
*address2
**'''''type: string'''''
*city
**'''''type: string'''''
*state
**'''''type: string'''''
*country
**'''''type: string'''''
*zip_code
**'''''type: string'''''
*tax_id_or_ssn
**'''''type: string'''''
*ref
**'''''type: string'''''
**Tracking code to identifier who referred this affiliate.
*minimum_payout
**'''''type: string'''''
**Threshold for generating affiliate payouts. Affiliate will not be paid until they earn at least this much.
*join_ip
**'''''type: string'''''
*custom1
**'''''type: string'''''
**An additional custom value to store with this affiliate. (255 max)
*custom2
**'''''type: string'''''
**An additional custom value to store with this affiliate. (255 max)
*custom3
**'''''type: string'''''
**An additional custom value to store with this affiliate. (255 max)
*custom4
**'''''type: string'''''
**An additional custom value to store with this affiliate. (255 max)
*custom5
**'''''type: string'''''
**An additional custom value to store with this affiliate. (255 max)
*affiliate_manager_loginid
**'''''type: string'''''
**loginid of the Affiliate Manager to assign to the affiliate being edited. If a manager is already set for the affiliate, this new manager will be set in addition to the existing one, not replace it.

== '''Example Request''' ==

'''PATCH'''
<pre>
<nowiki>
http://domain/api/affiliate/edit_affiliate
loginid = 4002
password = apitest
firstname = hello
lastname = test
email = hello@offerit.com
company = Offerit
url = offerit.com
tel = 666-666-6666
icq = 666666666
aim = sixsixsix
msn = sixsixtysix
address1 = 666 666 st
address2 =
city = My City
state = My State
country = USA
zip_code = 12345

</nowiki>
</pre>
*Response:
<pre>
[
{
"result":"Success","
}
]
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$url = 'http://domain/api/affiliate/edit_affiliate';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = array(
'loginid' => 4002,
'password' => 'apitest',
'firstname' => 'hello',
'lastname' => 'test',
'email' => 'hello3@offerit.com',
'company' => 'Offerit',
'url' => 'offerit.com',
'tel' => '666-666-6666',
'icq' => '666666666',
'aim' => 'sixsixsix',
'msn' => 'sixsixtysix',
'address1' => '666 666 st',
'address2' => '',
'city' => 'My City',
'state' => 'My State',
'country' => 'USA',
'zip_code' => '12345',
'join_ip' => '192.168.1.1',
);

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

[[Category:Offerit API Articles]]

Offerit REST API Add Offer

2020-09-08T19:19:12Z

Offeritnick: /* Offer Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /offer/add_offer''' ==
'''Description'''
*add_offer adds a new offer

'''Resource URL'''
*<nowiki>http://domain/api/offer/add_offer</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*POST

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
=== '''Offer Parameters''' ===
*name
**'''''type: string'''''
**'''''required'''
**Offer Name
*offer_description
**'''''type: string'''''
**Description to display to affiliates
*hidden
**'''''type: bool'''''
**0 or 1. If set to 1, offer does not show up in the affiliate offer list.
*date_live
**'''''type: string'''''
**Time when offer should become available to affiliates. String to time on the string provided. Default is empty.
*date_expire
**'''''type: string'''''
**Time when offer should stop being available to affiliates. String to time on the string provided. Default is empty.
*featured
**'''''type: bool'''''
**Flags this as a featured offer. Default FALSE.
*expire_url
**'''''type: string'''''
**External URL to redirect traffic to if the offer is expired.
*expire_landing_pageid
**'''''type: string'''''
**ID of landing page to redirect traffic to if the offer is expired.
*no_personal_member_info
**'''''type: string'''''
**Prevent name and address information from being stored in the customer record
*subject_lines
**'''''type: string'''''
**Comma separated list of recommended subject lines for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled
*from_addresses
**'''''type: string'''''
**Comma separated list of recommended from addresses for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled
*ip_lookup
**'''''type: Bool'''''
** Set cookieless tracking to match on only IP instead of IP+Browser Details. Default FALSE.
*ip_uniqueness_seconds
**'''''type: int'''''
**Set the number of seconds before a repeat visit by the same visitor will trigger the 'unique' offer redirect contition. This does not affect them showing as unique in stats. Default is unset on the offer level and inheriting from the "Unique Visitor Time" configuration setting.
*offer_groups
**'''''type: int,string,array'''''
**Accepts an existing offer group id, comma separated list of group ids, or array of group ids to associate with this offer.
*marketing_types
**'''''type: int,string,array'''''
**Accepts an existing marketing type id, comma separated list of marketing type ids, or array of marketing type ids to associate with this offer.
*categories
**'''''type: int,string,array'''''
**Accepts an existing category id or category name, comma separated list of ids/names, or array of ids/names to associate with this offer. Creates new categories if a category name is passed that does not exist.
*authorized
**'''''type: string,array'''''
**Accepts a comma separated list or array of 2 letter country codes where traffic is authorized to use this offer. Defaults to the 'Default Authorized Countries' configuration setting.
*unauthorized
**'''''type: string,array'''''
**Accepts a comma separated list or array of 2 letter country codes where traffic is not authorized to use this offer. Defaults to the 'Default Unauthorized Countries' configuration setting.
If no authorized or unauthorized countries are set even after checking the network configurations, the offer is authorized for all countries by default.
*remove_ocode
**'''''type: Bool'''''
** Remove ocode when sending surfer to landing page. Default FALSE to pass along.

==='''Advertiser Parameters'''===
*advertiserid
**'''''type: int'''''
**Loginid of advertiser account associated with this offer. Default none.
*advertiser_cost_type
**'''''type: string'''''
**'''''options:'''''
***conversion:flat amount per conversion
***dynamic_conversion:uses the revenue passed with the conversion
***sale:calculate a percentage of the gross sale amount reported by the advertiser
***click:a flat amount per click
***unique:a flat amount per unique click
**If there is an advertiser associated with this offer, how is offer revenue calculated. Default none.
*advertiser_cost_flat
**'''''type: string'''''
**Flat cost to advertisers. used with 'conversion','click','unique'
*advertiser_cost_perc
**'''''type: string'''''
**Percentage cost to advertiser used with 'sale'

==='''Fraud Prevention Parameters'''===
*ip_conversion_limit_flag
**'''''type: int'''''
**'''''options'''''
***0: Inherit from Network Configuration
***1: No Limit on this offer
***2: Specify Limimt on this offer
**Comma separated list of recommended from addresses for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled. Default 0.
*ip_conversion_limit
**'''''type: int'''''
**Number of conversions allowed per IP to this offer in any 24 hour time period. Only checked if ip_conversion_limit_flag=2. Default 0.
*ip_conversion_group
**'''''type: int'''''
**'''''options'''''
***0: This offer only
***x: Group id of any offer group.
**Controls the scope of ip_conversion_limit. Default is 0, this offer only. Specifying a group id will count all conversion for offers in that group
*prevent_cookie_dupes
**'''''type: Bool'''''
**Checks a cookie to block surfers that have already converted on this offer during the cookie lifetime. Default FALSE.
*pending_approval_lockout
**'''''type: int'''''
**Minimum number of seconds that must pass between a click and a conversion for that conversion to be automatically approved. While this setting is in effect, all conversions on this offer are treated as pending. If the lockout period has been reached, the system will record both a pending conversion and an approved conversion automatically. Default 0 to disable.

==='''Revenue Parameters'''===
*conversion_default
**'''''type: string'''''
**Amount used if none is specified in the conversion. Default none.
*conversion_default_type
**'''''type: int'''''
**'''''options'''''
***1:Revenue
***2:Gross
** Specify if the amount specified in conversion_default is revenue or gross. Default 1 for revenue
*continuity_default
**'''''type: int'''''
**Amount used if none is specified in the continuity. Default none.
*continuity_default_type
**'''''type: string'''''
**'''''options'''''
***1:Revenue
***2:Gross
** Specify if the amount specified in continuity_default is revenue or gross. Default 1 for revenue

==='''Commission Parameters'''===
*percentage_commission_source
**'''''type: int''''
**'''''options'''''
***0:Revenue
***1:Gross
** Specify whether revenue or gross should be used as the base when affiliate are paid a percentage. Default 0 for revenue
*hide_payout_string
**'''''type: bool''''
**Hide the automatically generated commission description and use the description in 'commission_description' instead.
*commission_description
**'''''type: string''''
**Custom description displayed to affiliates to explain how commissions are calculated for this offer.
*commission_type
**'''''type: string''''
**'''''options'''''
***cpa:Flat per CPA. Works with flat_amount_per_conversion and flat_amount_per_continuity
***cps:Percentage of Sale. Works with percentage_of_customer_conversion and percentage_of_customer_continuity
***click:Flat per Click. Works with flat_amount_per_click and flat_amount_per_visitor
***hybrid:Hybrid. Works with all fields.
**Specify what type of commission this offer will pay.
*flat_amount_per_click
**'''''type: decimal''''
** Flat commission paid for every raw click. Works with click or hybrid
*flat_amount_per_visitor
**'''''type: decimal''''
** Flat commission paid for every unique click. Works with click or hybrid
*flat_amount_per_conversion
**'''''type: decimal''''
** Flat commission paid for every conversion. Works with cpa or hybrid
*flat_amount_per_continuity
**'''''type: decimal''''
** Flat commission paid for every continuity. Works with cpa or hybrid
*percentage_of_customer_conversion
**'''''type: decimal''''
** Percentage of conversion revenue to pay as commission. Works with cps or hybrid
*percentage_of_customer_continuity
**'''''type: decimal''''
** Percentage of continuity revenue to pay as commission. Works with cps or hybrid
*retro_payout
**'''''type: bool''''
*All transactions for a customer will use the commission settings in place at the time of the first transaction.
*hide_deductions
**'''''type: bool''''
*Only show voids / chargebacks in affiliate statistics if they affected affiliate commissions.
*hide_continuities
**'''''type: bool''''
*Only show continuities in affiliate statistics if they affected affiliate commissions.
*hide_conversions
**'''''type: bool''''
*Only show conversions in affiliate statistics if they affected affiliate commissions.
*deduct_voids
**'''''type: bool''''
**When enabled, voids will reverse the commission paid to the affiliate on the original transaction that is being voided
*deduct_chargebacks
**'''''type: bool''''
**When enabled, chargebacks will reverse the commission paid to the affiliate on the original transaction that is being charged back
*min_deduct_date
**'''''type: string''''
**Date for stringtotime. Transactions before this date will never have their commissions removed by a void or chargeback.
*deduct_window
**'''''type: int''''
**If a void or chargeback is reported more than this many days after the original transaction, the affiliate will not have their commission removed even if deduct_voids or deduct_chargebacks is enabled.

=== '''Landing Page Parameters''' ===
*url
**'''''type: string'''''
**'''''required'''
**Landing Page url
*preview_url
**'''''type: string'''''
**Clean url to display to affiliates
*tracking_domain
**'''''type: string'''''
**One of your already defined tracking domains
*thumb_url
**'''''type: string'''''
**Url of offer thumbnail image.
*force_url
**'''''type: string'''''
**Url to screenshot for thumbnail.
*language
**'''''type: int''''
**id of one of your defined languages from the offers admin.
*conversion_type
**'''''type: string'''''
**'''''options: iframe,post,image'''''
**Type of conversion to use for this offer
*postback_ips
**'''''type: string'''''
**Comma separated list of ips that are allowed to post conversions to this offer. Default is no restriction
*hostnpost_ips
**'''''type: string'''''
**Comma separated list of ips that are allowed to post hostandpost conversions to this offer. Default is no restriction
*void_ips
**'''''type: string'''''
**Comma separated list of ips that are allowed to post voids to this offer. Default is deny all.
*private
**'''''type: bool'''''
**TRUE means the default landing page for the new offer will be private. Default is FALSE.
*requestable
**'''''type: bool'''''
**TRUE means the default landing page for the new offer will be requestable if it is also private. Default is FALSE.
*internal_desc
**'''''type: string'''''
**Landing page description for the new offer that is only in the admin interface. Default is empty.
*redirect_hash
**'''''type: string'''''
**Matching field for identifying what landing page to use when geo redirecting within an offer group. Default is empty.
*disable_url_sanitization
**'''''type: bool'''''
**Uses landing page url exactly as provided without encoding any invalid url characters. Default is false, encoding invalid url characters in the landing page.
*disable_deep_linking
**'''''type: bool'''''
**Discards any extra path and variables specified by the affilaite on the tracking link. Default is false, allowing the affiliate to affect the landing page url.

== '''Example Request''' ==

'''POST'''
<pre>
<nowiki>
http://domain/api/offer/add_offer
name=API TEST OFFER
url=http://example.com/?id=%%click_hash%%
preview_url=http://example.com/
authorized=DE,ES
advertiserid=1
advertiser_cost_type=conversion
advertiser_cost_flat=20
commission_type=201
flat_amount_per_conversion=15
flat_amount_per_continuity=5
</nowiki>
</pre>

*Response:
<pre>
{
"result":"Success",
"message":{
"landing_pageid":"432",
"offerid":"400"
}
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/offer/add_offer';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'name' => 'API TEST Offer',
'url' => 'http://example.com/?id=%%click_hash%%',
'preview_url' => 'http://example.com/',
'authorized' => 'DE,ES',
'advertiserid' => 1,
'advertiser_cost_type' => 'conversion',
'advertiser_cost_flat'=> 20,
'commission_type' => 201,
'flat_amount_per_conversion' => 15,
'flat_amount_per_continuity' => 5,
);

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Offer Get Details

2020-07-28T17:48:21Z

Offeritnick: /* GET /offer/get_details ***COMING SOON*** */

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /offer/get_details''' ==
'''Description'''
*API resource to get offer details

'''Resource URL'''
*<nowiki>http://domain/api/offer/get_details</nowiki>
*Replace domain with the Offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''This API requires either offerid, name, name_like, advertiserid, or advertiser_username. If none are supplied, no results will be returned. If multiple are supplied, only one will be prioritized and used based on the order listed. (ex: if both offerid and name are supplied, only offerid will be used to do the lookup. If name and advertiserid are supplied, only name will be used to do the lookup)''.'''

*offerid
**'''''type: string'''''
**'''''optional'''''
**Offerid or comma separated list of offerids to get details for

*name
**'''''type: string'''''
**'''''optional'''''
**Exact name of the offer to get details for

*name_like
**'''''type: string'''''
**'''''optional'''''
**Name fragment of the offer(s) to get details for

*advertiserid
**'''''type: int'''''
**'''''optional'''''
**Advertiserid to get offers and details for

*advertiser_username
**'''''type: string'''''
**'''''optional'''''
**Username of advertiser to get offers and details for

*return_columns
**'''''type: string'''''
**'''''allowed values:''''' active, admin_threshold_email, adv_cpm_click, advertiser_username, advertiserid, affiliate_payout, allow_s2s_ip, allowed_hours, allowed_states, approved, authorized_countries, authorized_countries_iso, categories, commission, commission_description, conversion, conversion_cap, conversion_trans_type, continuity, conversion_type, cookie_duration, cost_flat, cost_perc, cost_type, created_by, date_added, date_expire, date_live, deduct_full_customer_commission, deduct_window, deleted, expire_offer, expire_program, expire_url, featured, geoip_group_redirect, groups, hidden, hide_payout_string, ip_conversion_group, ip_conversion_limit, ip_conversion_limit_flag, ip_lookup, ip_uniqueness_seconds, landing_pages, marketing_types, min_deduct_date, mobile_landing_page, '''name''', no_personal_member_info, offer, '''offer_description''', offer_group, offer_limit, offer_limit_addition, offer_limit_deduction, offer_note, offer_quantity, '''offerid''', pending_approval_lockout, prevent_cookie_dupes, remove_ocode, reuse_active, revenue_amount, revenue_click, revenue_conversion, revenue_impression, revenue_sale, revenue_type, status, subject_lines, suppress_continuity_pixels, suppress_conversion_pixels, thumb_last_modified, thumbnail_url, timezone, type, unauthorized_countries, unauthorized_countries_iso, unique_duration
**'''''optional'''''
**Comma separated list of data columns to return for each offer. "offerid" will always be included in the data for each offer. If no return columns are specified, all details will be returned.

*start
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to start at specific section of the result set.

*count
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to limit how many offers are returned in the result set.

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = Array(
'offerid' => '136',
//'name_like' => 'Offer',
//'name' => 'API TEST Offer 123',
'return_columns' => 'name, cost_type, advertiser, advertiser_username, conversion, continuity',
);

$data_string = http_build_query($data);
$url = 'http://domain/api/offer/get_details?'.$data_string;

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_HTTPGET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

*Response:
<pre>
Array
(
[result] => success
[message] => Offer Found
[offer_count] => 1
[offer_details] => Array
(
[136] => Array
(
[advertiser_username] => advertiser1
[advertiserid] => 6
[continuity] => 10.00
[conversion] => 10.00
[cost_type] => Per Conversion (dynamic from url)
[name] => advertiser1Offer2
[offerid] => 136
)

)

)
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Get Links

2020-07-28T17:47:23Z

Offeritnick: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /affiliate/get_links''' ==
'''Description'''
*Gets all tracking links for an affiliate. Optionally lets you limit to a specific offer or landing page.

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/get_links</nowiki>

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*loginid
**'''''type: int'''''
**'''''required'''
** affiliate to get link for
*offerid
**'''''type: int'''''
** Optional offer to get link for
*landing_pageid
**'''''type: int'''''
** Optional landing page to get link for. Defaults to default lander for the offer.
*style
**'''''type: string'''''
**'''''options: encoded,ids,shortnames,tiny'''''
** Optional link style. Defaults to encoded.
*subaff
**'''''type: string'''''
** Optional subaff value. Defaults to none.
*subaff2
**'''''type: string'''''
** Optional subaff2 value. Defaults to none.
*subaff3
**'''''type: string'''''
** Optional subaff3 value. Defaults to none.
*subaff4
**'''''type: string'''''
** Optional subaff4 value. Defaults to none.
*subaff5
**'''''type: string'''''
** Optional subaff5 value. Defaults to none.
*subids
**'''''type: string'''''
** Optional comma separated list of subids. Defaults to none.
*_ocid
**'''''type: string'''''
** Optional click id value. Defaults to none.
*code_only
**'''''type: Bool'''''
** Optional - returns only the code from the tracking link. Defaults to full url.
*get_countries
**'''''type: Bool'''''
** Optional - return the authorized and unauthorized countries for each link.
*get_commission
**'''''type: Bool'''''
** Optional - return the commission string for each link.
*get_hidden
**'''''type: Int'''''
** Optional - 0 to return landing pages that are not hidden, 1 only hidden landing pages, 2 all. If not sent, will behave as if you passed 0 for only landing pages that are not hidden.
*get_hidden_offers
**'''''type: Int'''''
** Optional - 0 to return offers that are not hidden, 1 only hidden offers, 2 all offers. If not sent, will behave as if you passed 2 for all offers.
*get_advertiser
**'''''type: Bool'''''
** Optional - return the advertiser id and username for each link

== '''Example Request''' ==

'''GET'''

<pre><nowiki>http://domain/api/affiliate/get_links?loginid=2&offerid=1&subaff=test&_ocid={token}
</nowiki></pre>

*Response:
<pre>
{
"result":"Success",
"message":[
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":425,
"Landing Page Name":"lp333",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjQyNS4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
},
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":304,
"Landing Page Name":"offerit offer",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjMwNC4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
}
]
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/affiliate/get_links';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'loginid' => 2,
'offerid' => 1,
'subaff' => 'test',
'_ocid' => '{token}'
);

$data_string = http_build_query($data);
$url .= '?'.$data_string;

curl_setopt($curl, CURLOPT_GET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Multi Factor Authentication

2020-07-18T21:58:00Z

Offeritnick: /* Configuration */

{{Offerit Manual}}
[[Category:Offerit Affiliate Information]]
Multi factor authentication (Two factor authentication) a feature in [[Offerit]] that gives users the option to protect access to their account with Google Authenticator.

== Configuration ==
There are two configuration options you can set for Multi Factor Authentication.
* Drift Window (Configation->Security->Two Factor Authentication): accounts for desynchronized clocks, letting tokens that are slightly older or newer than expected work.
 [[File:MFA_Drift.png|600px]] 

* Affiliate Login Form MFA (Configation->Display->External Page): adds the MFA field to our default affiliate login templates.
 [[File:MFA_Display.png|600px]] 

== Enabling ==

There is an 'Two Factor Authentication' action in the affiliates admin.
 [[File:MFA_Admin.png|600px]] 

Then you can generate a new qr code.
 [[File:MFA_Generate.png|600px]] 
== Validating ==

Use your app to scan the qr code or generate a new one and type in the token, then click 'Enable Two Factor'.
 [[File:MFA_Admin_validate.png|600px]] 
Enabled status will change to Active.

== Logging In ==
If you added MFA field to the default login process, you will see it in the template all the time.
 [[File:MFA_Login.png|600px]] 
If not, you will be prompted to verify your information a second time, or can directly load
(/external.php?page=access&code=12),

If you use a customized template or external login form, you will need to add a field with name='twofactor' to pass the token in.

Multi Factor Authentication

2020-07-18T21:57:47Z

Offeritnick: /* Configuration */

{{Offerit Manual}}
[[Category:Offerit Affiliate Information]]
Multi factor authentication (Two factor authentication) a feature in [[Offerit]] that gives users the option to protect access to their account with Google Authenticator.

== Configuration ==
There are two configuration options you can set for Multi Factor Authentication.
* Drift Window (Configation->Security->Two Factor Authentication
): accounts for desynchronized clocks, letting tokens that are slightly older or newer than expected work.
 [[File:MFA_Drift.png|600px]] 

* Affiliate Login Form MFA (Configation->Display->External Page): adds the MFA field to our default affiliate login templates.
 [[File:MFA_Display.png|600px]] 

== Enabling ==

There is an 'Two Factor Authentication' action in the affiliates admin.
 [[File:MFA_Admin.png|600px]] 

Then you can generate a new qr code.
 [[File:MFA_Generate.png|600px]] 
== Validating ==

Use your app to scan the qr code or generate a new one and type in the token, then click 'Enable Two Factor'.
 [[File:MFA_Admin_validate.png|600px]] 
Enabled status will change to Active.

== Logging In ==
If you added MFA field to the default login process, you will see it in the template all the time.
 [[File:MFA_Login.png|600px]] 
If not, you will be prompted to verify your information a second time, or can directly load
(/external.php?page=access&code=12),

If you use a customized template or external login form, you will need to add a field with name='twofactor' to pass the token in.

Offerit REST API Offer Get Details

2020-06-24T17:10:15Z

Offeritnick: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /offer/get_details''' ***COMING SOON*** ==
'''Description'''
*API resource to get offer details

'''Resource URL'''
*<nowiki>http://domain/api/offer/get_details</nowiki>
*Replace domain with the Offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''This API requires either offerid, name, name_like, advertiserid, or advertiser_username. If none are supplied, no results will be returned. If multiple are supplied, only one will be prioritized and used based on the order listed. (ex: if both offerid and name are supplied, only offerid will be used to do the lookup. If name and advertiserid are supplied, only name will be used to do the lookup)''.'''

*offerid
**'''''type: string'''''
**'''''optional'''''
**Offerid or comma separated list of offerids to get details for

*name
**'''''type: string'''''
**'''''optional'''''
**Exact name of the offer to get details for

*name_like
**'''''type: string'''''
**'''''optional'''''
**Name fragment of the offer(s) to get details for

*advertiserid
**'''''type: int'''''
**'''''optional'''''
**Advertiserid to get offers and details for

*advertiser_username
**'''''type: string'''''
**'''''optional'''''
**Username of advertiser to get offers and details for

*return_columns
**'''''type: string'''''
**'''''allowed values:''''' active, admin_threshold_email, adv_cpm_click, advertiser_username, advertiserid, affiliate_payout, allow_s2s_ip, allowed_hours, allowed_states, approved, authorized_countries, authorized_countries_iso, categories, commission, commission_description, conversion, conversion_cap, conversion_trans_type, continuity, conversion_type, cookie_duration, cost_flat, cost_perc, cost_type, created_by, date_added, date_expire, date_live, deduct_full_customer_commission, deduct_window, deleted, expire_offer, expire_program, expire_url, featured, geoip_group_redirect, groups, hidden, hide_payout_string, ip_conversion_group, ip_conversion_limit, ip_conversion_limit_flag, ip_lookup, ip_uniqueness_seconds, landing_pages, marketing_types, min_deduct_date, mobile_landing_page, '''name''', no_personal_member_info, offer, '''offer_description''', offer_group, offer_limit, offer_limit_addition, offer_limit_deduction, offer_note, offer_quantity, '''offerid''', pending_approval_lockout, prevent_cookie_dupes, remove_ocode, reuse_active, revenue_amount, revenue_click, revenue_conversion, revenue_impression, revenue_sale, revenue_type, status, subject_lines, suppress_continuity_pixels, suppress_conversion_pixels, thumb_last_modified, thumbnail_url, timezone, type, unauthorized_countries, unauthorized_countries_iso, unique_duration
**'''''optional'''''
**Comma separated list of data columns to return for each offer. "offerid" will always be included in the data for each offer. If no return columns are specified, all details will be returned.

*start
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to start at specific section of the result set.

*count
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to limit how many offers are returned in the result set.

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = Array(
'offerid' => '136',
//'name_like' => 'Offer',
//'name' => 'API TEST Offer 123',
'return_columns' => 'name, cost_type, advertiser, advertiser_username, conversion, continuity',
);

$data_string = http_build_query($data);
$url = 'http://domain/api/offer/get_details?'.$data_string;

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_HTTPGET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

*Response:
<pre>
Array
(
[result] => success
[message] => Offer Found
[offer_count] => 1
[offer_details] => Array
(
[136] => Array
(
[advertiser_username] => advertiser1
[advertiserid] => 6
[continuity] => 10.00
[conversion] => 10.00
[cost_type] => Per Conversion (dynamic from url)
[name] => advertiser1Offer2
[offerid] => 136
)

)

)
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Get Links

2020-06-22T22:11:19Z

Offeritnick: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /affiliate/get_links''' ==
'''Description'''
*Gets all tracking links for an affiliate. Optionally lets you limit to a specific offer or landing page.

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/get_links</nowiki>

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*loginid
**'''''type: int'''''
**'''''required'''
** affiliate to get link for
*offerid
**'''''type: int'''''
** Optional offer to get link for
*landing_pageid
**'''''type: int'''''
** Optional landing page to get link for. Defaults to default lander for the offer.
*style
**'''''type: string'''''
**'''''options: encoded,ids,shortnames,tiny'''''
** Optional link style. Defaults to encoded.
*subaff
**'''''type: string'''''
** Optional subaff value. Defaults to none.
*subaff2
**'''''type: string'''''
** Optional subaff2 value. Defaults to none.
*subaff3
**'''''type: string'''''
** Optional subaff3 value. Defaults to none.
*subaff4
**'''''type: string'''''
** Optional subaff4 value. Defaults to none.
*subaff5
**'''''type: string'''''
** Optional subaff5 value. Defaults to none.
*subids
**'''''type: string'''''
** Optional comma separated list of subids. Defaults to none.
*_ocid
**'''''type: string'''''
** Optional click id value. Defaults to none.
*code_only
**'''''type: Bool'''''
** Optional - returns only the code from the tracking link. Defaults to full url.
*get_countries
**'''''type: Bool'''''
** Optional - return the authorized and unauthorized countries for each link.
*get_commission
**'''''type: Bool'''''
** Optional - return the commission string for each link.
*get_hidden
**'''''type: Int'''''
** Optional - 0 to return landing pages that are not hidden, 1 only hidden landing pages, 2 all. If not sent, will behave as if you passed 0 for only landing pages that are not hidden.
*get_hidden_offers
**'''''type: Int'''''
** Optional - 0 to return offers that are not hidden, 1 only hidden offers, 2 all offers. If not sent, will behave as if you passed 2 for all offers.
*get_advertiser *COMING SOON*
**'''''type: Bool'''''
** Optional - return the advertiser id and username for each link

== '''Example Request''' ==

'''GET'''

<pre><nowiki>http://domain/api/affiliate/get_links?loginid=2&offerid=1&subaff=test&_ocid={token}
</nowiki></pre>

*Response:
<pre>
{
"result":"Success",
"message":[
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":425,
"Landing Page Name":"lp333",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjQyNS4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
},
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":304,
"Landing Page Name":"offerit offer",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjMwNC4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
}
]
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/affiliate/get_links';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'loginid' => 2,
'offerid' => 1,
'subaff' => 'test',
'_ocid' => '{token}'
);

$data_string = http_build_query($data);
$url .= '?'.$data_string;

curl_setopt($curl, CURLOPT_GET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Offer Get Details

2020-06-22T21:31:21Z

Offeritnick: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /offer/get_details''' ***COMING SOON*** ==
'''Description'''
*API resource to get offer details

'''Resource URL'''
*<nowiki>http://domain/api/offer/get_details</nowiki>
*Replace domain with the Offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''This API requires either offerid, name, name_like, advertiserid, or advertiser_username. If none are supplied, no results will be returned. If multiple are supplied, only one will be prioritized and used based on the order listed. (ex: if both offerid and name are supplied, only offerid will be used to do the lookup. If name and advertiserid are supplied, only name will be used to do the lookup)''.'''

*offerid
**'''''type: string'''''
**'''''optional'''''
**Offerid or comma separated list of offerids to get details for

*name
**'''''type: string'''''
**'''''optional'''''
**Exact name of the offer to get details for

*name_like
**'''''type: string'''''
**'''''optional'''''
**Name fragment of the offer(s) to get details for

*advertiserid
**'''''type: int'''''
**'''''optional'''''
**Advertiserid to get offers and details for

*advertiser_username
**'''''type: string'''''
**'''''optional'''''
**Username of advertiser to get offers and details for

*return_columns
**'''''type: string'''''
**'''''allowed values:''''' active, admin_threshold_email, adv_cpm_click, advertiser_username, advertiserid, affiliate_payout, allow_s2s_ip, allowed_hours, allowed_states, approved, authorized_countries, authorized_countries_iso, categories, commission, commission_description, conversion, conversion_cap, conversion_trans_type, continuity, conversion_type, cookie_duration, cost_flat, cost_perc, cost_type, created_by, date_added, date_expire, date_live, deduct_full_customer_commission, deduct_window, deleted, expire_offer, expire_program, expire_url, featured, geoip_group_redirect, groups, hidden, hide_payout_string, ip_conversion_group, ip_conversion_limit, ip_conversion_limit_flag, ip_lookup, ip_uniqueness_seconds, landing_pages, marketing_types, min_deduct_date, mobile_landing_page, '''name''', no_personal_member_info, offer, '''offer_description''', offer_group, offer_limit, offer_limit_addition, offer_limit_deduction, offer_note, offer_quantity, '''offerid''', pending_approval_lockout, prevent_cookie_dupes, remove_ocode, reuse_active, revenue_amount, revenue_click, revenue_conversion, revenue_impression, revenue_sale, revenue_type, status, subject_lines, suppress_continuity_pixels, suppress_conversion_pixels, thumb_last_modified, thumbnail_url, timezone, type, unauthorized_countries, unauthorized_countries_iso, unique_duration
**'''''optional'''''
**Comma separated list of data columns to return for each offer. If not specified, all details will be returned

*start
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to start at specific section of the result set.

*count
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to limit how many offers are returned in the result set.

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = Array(
'offerid' => '136',
//'name_like' => 'Offer',
//'name' => 'API TEST Offer 123',
'return_columns' => 'name, cost_type, advertiser, advertiser_username, conversion, continuity',
);

$data_string = http_build_query($data);
$url = 'http://domain/api/offer/get_details?'.$data_string;

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_HTTPGET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

*Response:
<pre>
Array
(
[result] => success
[message] => Offer Found
[offer_count] => 1
[offer_details] => Array
(
[136] => Array
(
[advertiser_username] => advertiser1
[advertiserid] => 6
[continuity] => 10.00
[conversion] => 10.00
[cost_type] => Per Conversion (dynamic from url)
[name] => advertiser1Offer2
[offerid] => 136
)

)

)
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Offer Get Details

2020-06-22T21:30:03Z

Offeritnick: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /offer/get_details''' ***COMING SOON*** ==
'''Description'''
*API resource to get offer details

'''Resource URL'''
*<nowiki>http://domain/api/offer/get_details</nowiki>
*Replace domain with the Offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''This API requires either offerid, name, name_like, advertiserid, or advertiser_username. If none are supplied, no results will be returned. If multiple are supplied, only one will be prioritized and used based on the order listed. (ex: if both offerid and name are supplied, only offerid will be used to do the lookup. If name and advertiserid are supplied)''.'''

*offerid
**'''''type: string'''''
**'''''optional'''''
**Offerid or comma separated list of offerids to get details for

*name
**'''''type: string'''''
**'''''optional'''''
**Exact name of the offer to get details for

*name_like
**'''''type: string'''''
**'''''optional'''''
**Name fragment of the offer(s) to get details for

*advertiserid
**'''''type: int'''''
**'''''optional'''''
**Advertiserid to get offers and details for

*advertiser_username
**'''''type: string'''''
**'''''optional'''''
**Username of advertiser to get offers and details for

*return_columns
**'''''type: string'''''
**'''''allowed values:''''' active, admin_threshold_email, adv_cpm_click, advertiser_username, advertiserid, affiliate_payout, allow_s2s_ip, allowed_hours, allowed_states, approved, authorized_countries, authorized_countries_iso, categories, commission, commission_description, conversion, conversion_cap, conversion_trans_type, continuity, conversion_type, cookie_duration, cost_flat, cost_perc, cost_type, created_by, date_added, date_expire, date_live, deduct_full_customer_commission, deduct_window, deleted, expire_offer, expire_program, expire_url, featured, geoip_group_redirect, groups, hidden, hide_payout_string, ip_conversion_group, ip_conversion_limit, ip_conversion_limit_flag, ip_lookup, ip_uniqueness_seconds, landing_pages, marketing_types, min_deduct_date, mobile_landing_page, '''name''', no_personal_member_info, offer, '''offer_description''', offer_group, offer_limit, offer_limit_addition, offer_limit_deduction, offer_note, offer_quantity, '''offerid''', pending_approval_lockout, prevent_cookie_dupes, remove_ocode, reuse_active, revenue_amount, revenue_click, revenue_conversion, revenue_impression, revenue_sale, revenue_type, status, subject_lines, suppress_continuity_pixels, suppress_conversion_pixels, thumb_last_modified, thumbnail_url, timezone, type, unauthorized_countries, unauthorized_countries_iso, unique_duration
**'''''optional'''''
**Comma separated list of data columns to return for each offer. If not specified, all details will be returned

*start
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to start at specific section of the result set.

*count
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to limit how many offers are returned in the result set.

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = Array(
'offerid' => '136',
//'name_like' => 'Offer',
//'name' => 'API TEST Offer 123',
'return_columns' => 'name, cost_type, advertiser, advertiser_username, conversion, continuity',
);

$data_string = http_build_query($data);
$url = 'http://domain/api/offer/get_details?'.$data_string;

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_HTTPGET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

*Response:
<pre>
Array
(
[result] => success
[message] => Offer Found
[offer_count] => 1
[offer_details] => Array
(
[136] => Array
(
[advertiser_username] => advertiser1
[advertiserid] => 6
[continuity] => 10.00
[conversion] => 10.00
[cost_type] => Per Conversion (dynamic from url)
[name] => advertiser1Offer2
[offerid] => 136
)

)

)
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Offer Get Details

2020-06-22T21:03:42Z

Offeritnick: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /offer/get_details''' ***COMING SOON*** ==
'''Description'''
*API resource to get offer details

'''Resource URL'''
*<nowiki>http://domain/api/offer/get_details</nowiki>
*Replace domain with the Offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''This API requires either offerid, name, name_like, advertiserid, or advertiser_username. If none are supplied, no results will be returned. If multiple are supplied, only one will be prioritized and used based on the order listed. (ex: if both offerid and name are supplied, only offerid will be used to do the lookup)''.'''

*offerid
**'''''type: string'''''
**'''''optional'''''
**Offerid or comma separated list of offerids to get details for

*name
**'''''type: string'''''
**'''''optional'''''
**Exact name of the offer to get details for

*name_like
**'''''type: string'''''
**'''''optional'''''
**Name fragment of the offer(s) to get details for

*advertiserid
**'''''type: int'''''
**'''''optional'''''
**Advertiserid to get offers and details for

*advertiser_username
**'''''type: string'''''
**'''''optional'''''
**Username of advertiser to get offers and details for

*return_columns
**'''''type: string'''''
**'''''allowed values:''''' active, admin_threshold_email, adv_cpm_click, advertiser_username, advertiserid, affiliate_payout, allow_s2s_ip, allowed_hours, allowed_states, approved, authorized_countries, authorized_countries_iso, categories, commission, commission_description, conversion, conversion_cap, conversion_trans_type, continuity, conversion_type, cookie_duration, cost_flat, cost_perc, cost_type, created_by, date_added, date_expire, date_live, deduct_full_customer_commission, deduct_window, deleted, expire_offer, expire_program, expire_url, featured, geoip_group_redirect, groups, hidden, hide_payout_string, ip_conversion_group, ip_conversion_limit, ip_conversion_limit_flag, ip_lookup, ip_uniqueness_seconds, landing_pages, marketing_types, min_deduct_date, mobile_landing_page, '''name''', no_personal_member_info, offer, '''offer_description''', offer_group, offer_limit, offer_limit_addition, offer_limit_deduction, offer_note, offer_quantity, '''offerid''', pending_approval_lockout, prevent_cookie_dupes, remove_ocode, reuse_active, revenue_amount, revenue_click, revenue_conversion, revenue_impression, revenue_sale, revenue_type, status, subject_lines, suppress_continuity_pixels, suppress_conversion_pixels, thumb_last_modified, thumbnail_url, timezone, type, unauthorized_countries, unauthorized_countries_iso, unique_duration
**'''''optional'''''
**Comma separated list of data columns to return for each offer. If not specified, all details will be returned

*start
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to start at specific section of the result set.

*count
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to limit how many offers are returned in the result set.

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = Array(
'offerid' => '136',
//'name_like' => 'Offer',
//'name' => 'API TEST Offer 123',
'return_columns' => 'name, cost_type, advertiser, advertiser_username, conversion, continuity',
);

$data_string = http_build_query($data);
$url = 'http://domain/api/offer/get_details?'.$data_string;

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_HTTPGET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

*Response:
<pre>
Array
(
[result] => success
[message] => Offer Found
[offer_count] => 1
[offer_details] => Array
(
[136] => Array
(
[advertiser_username] => advertiser1
[advertiserid] => 6
[continuity] => 10.00
[conversion] => 10.00
[cost_type] => Per Conversion (dynamic from url)
[name] => advertiser1Offer2
[offerid] => 136
)

)

)
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Offer Get Details

2020-06-22T21:03:32Z

Offeritnick:

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /offer/get_details''' ***COMING SOON*** ==
'''Description'''
*API resource to get offer details

'''Resource URL'''
*<nowiki>http://domain/api/offer/get_details</nowiki>
*Replace domain with the Offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''This API requires either offerid, name, name_like, advertiserid, or advertiser_username. If none are supplied, no results will be returned. If multiple are supplied, only one will be prioritized and used based on the order listed. (ex: if both offerid and name are supplied, only offerid will be used to do the lookup)''.'''

*offerid
**'''''type: string'''''
**'''''optional'''''
**Offerid or comma separated list of offerids to get details for

*name
**'''''type: string'''''
**'''''optional'''''
**Exact name of the offer to get details for

*name_like
**'''''type: string'''''
**'''''optional'''''
**Name fragment of the offer(s) to get details for

*advertiserid
**'''''type: int'''''
**'''''optional'''''
**Advertiserid to get offers and details for

*advertiser_username
**'''''type: string'''''
**'''''optional'''''
**Username of advertiser to get offers and details for

*return_columns
**'''''type: string'''''
**'''''allowed values:''''' active, admin_threshold_email, adv_cpm_click, advertiser_username, advertiserid, affiliate_payout, allow_s2s_ip, allowed_hours, allowed_states, approved, authorized_countries, authorized_countries_iso, categories, commission, commission_description, conversion, conversion_cap, conversion_trans_type, continuity, conversion_type, cookie_duration, cost_flat, cost_perc, cost_type, created_by, date_added, date_expire, date_live, deduct_full_customer_commission, deduct_window, deleted, expire_offer, expire_program, expire_url, featured, geoip_group_redirect, groups, hidden, hide_payout_string, ip_conversion_group, ip_conversion_limit, ip_conversion_limit_flag, ip_lookup, ip_uniqueness_seconds, landing_pages, marketing_types, min_deduct_date, mobile_landing_page, '''name''', no_personal_member_info, offer, '''offer_description''', offer_group, offer_limit, offer_limit_addition, offer_limit_deduction, offer_note, offer_quantity, '''offerid''', pending_approval_lockout, prevent_cookie_dupes, remove_ocode, reuse_active, revenue_amount, revenue_click, revenue_conversion, revenue_impression, revenue_sale, revenue_type, status, subject_lines, suppress_continuity_pixels, suppress_conversion_pixels, thumb_last_modified, thumbnail_url, timezone, type, unauthorized_countries, unauthorized_countries_iso, unique_duration
**'''''optional'''''
**Comma separated list of data columns to return for each offer. If not specified, all details will be returned

*start
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to start at specific section of the result set.

*count
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to limit how many offers are returned in the result set.

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = Array(
'offerid' => '136',
//'name_like' => 'Offer',
//'name' => 'API TEST Offer 123',
'return_columns' => 'name, cost_type, advertiser, advertiser_username, conversion, continuity',
);

$data_string = http_build_query($data);
$url = 'http://domain/api/offer/get_details?'.$data_string;

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_HTTPGET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

*Response:
<pre>
Array
(
[result] => success
[message] => Offer Found
[offer_count] => 1
[offer_details] => Array
(
[136] => Array
(
[advertiser_username] => advertiser1
[advertiserid] => 6
[continuity] => 10.00
[conversion] => 10.00
[cost_type] => Per Conversion (dynamic from url)
[name] => advertiser1Offer2
[offerid] => 136
)

)

)
</pre>

[[Category:Offerit API Articles]]

Template:Offerit Manual

2020-06-22T18:09:52Z

Offeritnick:

{| class="offeritnavbox"
! [[Offerit|Offerit]]
{| class="mw-collapsible {{{show_for_affiliates_section|mw-collapsed}}}" width="100%"
! class="i1" | For Affiliates
|-
| [[Automatic SubIDs]]
|-
| [[Affiliate Stats Dumps|Affiliate Stats Dumps]]
|-
| [[Linkcode|Linkcode]]
|-
| [[Link Groups|Link Groups]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Host and Post]]

|}
{| class="mw-collapsible {{{show_affiliate_area_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Affiliate Area
|-

| [[Affiliate Account Details]]
|-
| [[Affiliate Account Change Log]]
|-
| [[Offerit Affiliate Creatives|Affiliate Creatives]]
|-
| [[Affiliate Creatives Search]]
|-
| [[Affiliate Settings]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Linkcodes]]
|-
| [[Affiliate Linkcode Settings]]
|-
| [[Affiliate Login History]]
|-
| [[Affiliate Messages]]
|-
| [[Affiliate Dashboard]]
|-
| [[Affiliate Dashboard Key Statistics|Dashboard Key Statistics]]
|-
| [[Affiliate Dashboard Statistics Summary|Dashboard Statistics Summary]]
|-
| [[Affiliate Payment History]]
|-
| [[Quick Links]]
|-
| [[Affiliate Referrals Report]]
|-
| [[Affiliate Referring URL Report]]
|-
| [[Affiliate Remote Login]]
|-
| [[Affiliate Signup]]
|-
| [[Affiliate Statistic Filters]]
|-
| [[Affiliate Statistic Views]]
|-
| [[Affiliate SubIDs]]



|}
{| class="mw-collapsible {{{show_setup_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Setup

|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[Tracking Domain]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]
|-
| [[Getting Started Admin]]
|-
| [[Offerit Quick-Start Guide]]
|-
| [[Tracking in Offerit]]
|-
| [[Pixel Builder]]
|-
| [[Offerit Postback Examples]]
|-
| [[Replacement Variables]]
|-
| [[Offerit Currency Exchange Rates|Currency Exchange Rates]]
|}
<hr />
{| class="mw-collapsible {{{show_admin_overview_section|mw-collapsed}}}" width="100%"
! class="i1" | Admin Dashboard
|-
| [[Admin Dashboard|The Admin Dashboard]]
|}
{| class="mw-collapsible {{{show_reporting_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Reporting Admin
|-
| [[Reporting Admin|The Reporting Admin]]
|-
| [[Track and Strack|Track and Strack]]
|-

|}
{| class="mw-collapsible {{{show_report_breakdowns_section|mw-collapsed}}}" width="100%"
! class="i1" |   Report Breakdowns
|-
| [[Profit and Loss Report|Profit and Loss Report]]
|-
| [[Subscription Report|Subscription Report]]
|-
| [[Transactions Report|Transactions Reports]]

|-
| [[Affiliate Ratios Report|Affiliate Ratios Report]]
|-
| [[Affiliate Managers Report]]
|-
| [[Surfer Actions Report|Visitor Actions Report]]
|-
| [[Affiliate Referral Tier Commissions Report|Referral Tier Payouts Report]]
|-
| [[Affiliate Referral Signup Commissions Report|Referral Signup Payouts Report]]
|-
| [[Additional Commissions Report|Additional Commissions Report]]
|-
| [[Graphical Affiliate Comparison Report|Graphical Affiliate Comparison Report]]
|-
| [[Single Day Comparison Report|The Single Day Comparison Report]]
|-
| [[Actual Affiliate Payments|Actual Affiliate Payments Report]]

|}
{| class="mw-collapsible {{{show_offers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Offers Admin
|-
| [[Offers Admin|The Offers Admin]]
|-
| [[Offers|Offers]]
|-
| [[Offer Setup]]
|-
| [[Affiliate Referrals]]
|-
| [[Tracking Domain]]
|-
| [[Offerit Commission|Commissions]]
|-
| [[Commission Changes]]
|-
| [[Suppression Lists]]
|-
| [[Pixel Builder]]

|-
| [[ID Numbers]]
|-
| [[Offer Partner]]

|-
| [[Offer/Landing Page Redirection]]
|-
| [[Offerit Rules|Setting Rules]]
|-
| [[Admin Host and Post]]
|-
| [[Offer Post URLs]]
|-
| [[Offer Goals]]
|}
{| class="mw-collapsible {{{show_affiliates_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Affiliates Admin
|-
| [[Affiliates Admin|The Affiliates Admin]]
|-
| [[ID Numbers]]
|-
| [[Affiliate Managers]]
|-
| [[Affiliate Referrals]]
|-
| [[Offerit Affiliate Activation|Affiliate Activation]]
|-
| [[Admin-Only Settings]]
|-
| [[Offerit Affiliate Override|Affiliate Overrides]]
|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[In House Accounts|In-House Accounts]]
|-
| [[Add Manual Sale]]
|-
| [[Offerit Manual Invoice|Manual Invoice]]
|-
| [[Offerit Affiliate Documents|Affiliate Documents]]
|-
| [[Affiliate Enabled Offers]]
|-
| [[Change Affiliate Status]]
|-
| [[Account Changes]]
|-
|}
{| class="mw-collapsible {{{show_advertisers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Advertisers Admin
|-
| [[Advertisers Admin|The Advertisers Admin]]
|-
| [[Account Changes]]
|-
| [[Advertiser Invoices]]
|-
| [[Generate Invoice]]
|-
| [[Advertiser Approval]]
|-
| [[Change Advertiser Status]]
|}
{| class="mw-collapsible {{{show_customers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Customers Admin
|-
| [[Customers Admin]]
|-
| [[Offerit Add Customer|Manually Adding a Customer]]
|-
| [[ID Numbers]]
|-
|}

{| class="mw-collapsible {{{show_payments_admin_section|mw-collapsed}}}" width="100%"
! class="i1" |Payments Admin
|-
| [[Payments Admin|The Payments Admin]]
|-
| [[Payvia Types]]
|-
| [[Payout Periods]]
|-
| [[Payvia Dump Formats]]
|-
| [[Payment Dump Entry Numbers |Payment Dump Entry Numbers]]
|-
| [[Offerit Payment Dump Variables|Payment Dump Variables]]
|-
| [[Offerit Check Functions|Check Functions]]
|-
| [[Offerit Rules|Setting Rules]]
|}
{| class="mw-collapsible {{{show_payment_methods_section|mw-collapsed}}}" width="100%"
! class="i1" |Payment Methods
|-
| [[Payza|Payza]]
|}
{| class="mw-collapsible {{{show_creatives_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Creatives Admin
|-
| [[Creatives Admin|The Creatives Admin]]

|-
| [[Offerit Add New Creatives|Add New Creatives]]
|-
| [[Offerit Add New Creative Type|Add New Creative Type]]
|-
| [[Offeritcode]]

|-
| [[Code Builder]]
|-
| [[Track and Strack]]
|-
| [[Offerit Rules|Setting Rules]]
|-
|}
{| class="mw-collapsible {{{show_creative_types_section|mw-collapsed}}}" width="100%"
! class="i1" |   Default Creative Types
|-
| [[Creative Types]]
|-
| [[Offerit Image Banners|Image Banners]]
|-
| [[Offerit Flash Banners|Flash Banners]]
|-
| [[Offerit Dynamic Text Banners|Dynamic Text Banners]]
|-
| [[Offerit Feeds|Feeds]]
|-
| [[Offerit Mailers|Mailers]]
|-
| [[Offerit Downloadable Videos|Video Download]]
|-
| [[Offerit Embedded Videos|Video Embed]]
|-
| [[Offerit Page Peels|Page Peels]]
|-
| [[Offerit IM Popups|IM Popups]]
|-
| [[Offerit Footer Ads|Footer Ads]]
|-
| [[Offerit Page Ads|Page Ads]]
|-
| [[Offerit Overlays|Overlays]]
|-
|}

{| class="mw-collapsible {{{show_communications_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Communications Admin
|-
| [[Communications Admin|The Communications Admin]]
|-
| [[Offerit Add News|Add News Item]]
|-
| [[Offerit Send Message|Sending Messages]]
|-
| [[Signup Questions]]

|}
{| class="mw-collapsible {{{show_configuration_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Configuration Admin
|-
| [[Configuration Admin|The Configuration Admin]]

|-
| [[Offerit Affiliate Signup Postback URL|Affiliate Signup Postback URL]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]

|}

{| class="mw-collapsible {{{show_rest_api_section|mw-collapsed}}}" width="100%"
! class="i1" | REST API
|-
! class="i1" | General
|-
| [[Offerit REST API Overview]]
|-
| [[Offerit REST API Ping|GET /service/ping]]
|-
| [[Offerit REST API Set Currency Exchange Rates|PATCH /service/set_currency_exchange_rates]]
|-
! class="i1" | Advertiser
|-
| [[Offerit REST API Edit Advertiser |PATCH /advertiser/edit_advertiser]]
|-
| [[Offerit REST API Add Advertiser |POST /advertiser/add_advertiser]]
|-
! class="i1" | Affiliate
|-
| [[Offerit REST API Get Links |GET /affiliate/get_links]]
|-
| [[Offerit REST API Get Single Link |GET /affiliate/get_single_link]]
|-
| [[Offerit REST API Search_Affiliate|GET /affiliate/search]]
|-
| [[Offerit REST API Decode Trackingcode|GET /affiliate/decode_trackingcode]]
|-
| [[Offerit REST API Edit Affiliate |PATCH /affiliate/edit_affiliate]]
|-
| [[Offerit REST API Set Affiliate Payvia Info|PATCH /affiliate/payvia]]
|-
| [[Offerit REST API Add Affiliate|POST /affiliate/add_affiliate]]
|-
| [[Offerit REST API Affiliate Login Ips|POST /affiliate/affiliate_login_ips]]
|-
! class="i1" | Creative
|-
| [[Offerit REST API Get Creatives |GET /creative/get_creatives]]
|-
| [[Offerit REST API Get Creatives Fields|GET /creative/get_creative_fields]]
|-
| [[Offerit REST API Get Creatives Rules|GET /creative/get_creative_rules]]
|-
| [[Offerit REST API Delete Creative|PATCH /creative/delete_creative]]
|-
| [[Offerit REST API Edit Creative|PATCH /creative/edit_creative]]
|-
| [[Offerit REST API Edit Creative Rules|PATCH /creative/edit_creative_rules]]
|-
| [[Offerit REST API Undelete Creative|PATCH /creative/undelete_creative]]
|-
| [[Offerit REST API Add Creative|POST /creative/add_creative]]
|-
| [[Offerit REST API Add Creative Rule|POST /creative/add_creative_rule]]
|-
| [[Offerit REST API Delete Creative Rules|POST /creative/delete_creative_rules]]
|-
! class="i1" | Customer
|-
| [[Offerit REST API Set Customer Details|PATCH /customer/set_customer_details]]
|-
| [[Offerit REST API Lock Customer|PATCH /customer/lock]]
|-
| [[Offerit REST API Unlock Customer|PATCH /customer/unlock]]
|-
| [[Offerit REST API Forget Customer|PATCH /customer/forget]]
|-
| [[Offerit REST API Export Customer|GET /customer/export]]
|-
! class="i1" | Offer
|-
| [[Offerit REST API Get Conversion Caps|GET /offer/get_conversion_caps]]
|-
| [[Offerit REST API Check Orderid Exists|GET /offer/check_orderid_exists]]
|-
| [[Offerit REST API Get Commission Changes|GET /offer/get_commission_changes]]
|-
| [[Offerit REST API Offer Get Details|GET /offer/get_details]]
|-
| [[Offerit REST API Activate Offer|PATCH /offer/activate_offer]]
|-
| [[Offerit REST API Edit Landing Page |PATCH /offer/edit_landing_page]]
|-
| [[Offerit REST API Edit Offer |PATCH /offer/edit_offer]]
|-
| [[Offerit REST API Pause Offer|PATCH /offer/pause_offer]]
|-
| [[Offerit REST API Set Commission Change Payouts|PATCH /offer/set_commission_change_payouts]]
|-
| [[Offerit REST API Set Enabled Affiliates |PATCH /offer/set_enabled_affiliates]]
|-
| [[Offerit REST API Set Offer Categories|PATCH /offer/set_offer_categories]]
|-
| [[Offerit REST API Set Offer Countries|PATCH /offer/set_offer_countries]]
|-
| [[Offerit REST API Set Offer Goals |PATCH /offer/set_offer_goals]]
|-
| [[Offerit REST API Set Offer Groups |PATCH /offer/set_offer_groups]]
|-
| [[Offerit REST API Set Offer Marketing Types|PATCH /offer/set_offer_marketing_types]]
|-
| [[Offerit REST API Store Offer Ips|PATCH /offer/store_offer_ips]]
|-
| [[Offerit REST API Add Commission Change |POST /offer/add_commission_change]]
|-
| [[Offerit REST API Add Landing Page |POST /offer/add_landing_page]]
|-
| [[Offerit REST API Add Offer |POST /offer/add_offer]]
|-
| [[Offerit REST API Add Tracking Domain |POST /offer/add_tracking_domain]]
|-
! class="i1" | Reporting
|-
| [[Offerit REST API Get Profit Loss Report|GET /report/profitloss]]
|-
| [[Offerit REST API Get Transaction Report|GET /report/transaction]]
|-
! class="i1" | Transaction
|-
| [[Offerit REST API Get Transaction Payout Preview|GET /transaction/transaction_payout_preview]]
|-
| [[Offerit REST API Transaction Update Revenue By Orderid |PATCH /transaction/transaction_update_revenue_by_orderid]]
|-
| [[Offerit REST API Transaction Update Revenue By Transaction Hash |PATCH /transaction/transaction_update_revenue_by_transaction_hash]]
|-
| [[Offerit REST API Process Void |POST /transaction/process_void]]
|-
| [[Offerit REST API Process Chargeback |POST /transaction/process_chargeback]]
|-
| [[Offerit REST API Process Reversal |POST /transaction/process_reversal]]
|-
| [[Offerit REST API Approve Pending Transaction |POST /transaction/approve_pending_transaction]]
|-
| [[Offerit REST API Click Detail |GET /transaction/click_detail]]
|}
{| class="mw-collapsible {{{show_api_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | SOAP API (*deprecated*)
|-
| [[Offerit API|API]]
|-
| [[Offerit API Add Affiliate|Add Affiliate]]
|-
| [[Offerit API Add Affiliate Sale|Add Affiliate Sale]]
|-
| [[Offerit API Add Offer|Add Offer]]
|-
| [[Offerit API Approve Transaction|Approve Transaction]]

|-
| [[Offerit API Creative Types|Creative Types]]
|-
| [[Offerit API Decode Offeritcode|Decode Offeritcode]]
|-
| [[Offerit API Deny Transaction|Deny Transaction]]
|-
| [[Offerit API Disable Affiliate Landing Page|Disable Affiliate Landing Page]]
|-
| [[Offerit API Edit Affiliate Sale|Edit Affiliate Sale]]
|-
| [[Offerit API Enable Affiliate Landing Page|Enable Affiliate Landing Page]]

|-
| [[Offerit API Get Affiliate Stats|Get Affiliate Stats]]
|-
| [[Offerit API Get Allowed Affiliates|Get Allowed Affiliates]]
|-
| [[Offerit API Get Landing Page Details|Get Landing Page Details]]
|-
| [[Offerit API Get Offer Details|Get Offer Details]]
|-
| [[Offerit API Get Offer List|Get Offer List]]
|-
| [[Offerit API Get Profit Loss Report|Get Profit Loss Report]]

|-
| [[Offerit API List Affiliate Details|List Affiliate Details]]
|-
| [[Offerit API List Affiliate Subaffiliates|List Affiliate Subaffiliates]]
|-
| [[Offerit API Ping|Ping]]
|-

|-
| [[Offerit API Set Affiliate Status|Set Affiliate Status]]

|-
| [[Offerit API Set Subaffiliate Status|Set SubAffiliate Status]]

|-
| [[Offerit API Set Member Details|Set Member Details]]
|-
| [[Offerit API Record Affiliate Click|Record Affiliate Click]]
|}
{| class="mw-collapsible {{{show_misc_section|mw-collapsed}}}" width="100%"
! class="i1" | Misc.
|-
| [[Offerit Rules|Rules]]
|-
| [[Offerit Freeform Date|Freeform Date]]
|-

| [[Affiliate Custom Signup]]
|-
| [[Offeritcode]]
|-
| [[Tracking in Offerit]]
|-
| [[Offerit Logos]]
|-
| [[Void Conversions Remotely]]
|-
|}
<hr />


|}<includeonly>[[Category:Offerit]]</includeonly>

Offerit REST API Offer Get Details

2020-06-22T18:06:59Z

Offeritnick: /* GET /offer/get_details ***COMING SOON*** */

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /offer/get_details''' ***COMING SOON*** ==
'''Description'''
*API resource to get offer details

'''Resource URL'''
*<nowiki>http://domain/api/offer/get_details</nowiki>
*Replace domain with the Offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''This API requires either offerid, name, or name_like. If none are supplied, no results will be returned. If multiple are supplied, only one will be prioritized and used based on the order listed. (ex: if both offerid and name are supplied, only offerid will be used to do the lookup)''.'''

*offerid
**'''''type: string'''''
**'''''optional'''''
**Offerid or comma separated list of offerids to get details for

*name
**'''''type: string'''''
**'''''optional'''''
**Exact name of the offer to get details for

*name_like
**'''''type: string'''''
**'''''optional'''''
**Name fragment of the offer(s) to get details for

*return_columns
**'''''type: string'''''
**'''''allowed values:''''' active, admin_threshold_email, adv_cpm_click, advertiser_username, advertiserid, affiliate_payout, allow_s2s_ip, allowed_hours, allowed_states, approved, authorized_countries, authorized_countries_iso, categories, commission, commission_description, conversion, conversion_cap, conversion_trans_type, continuity, conversion_type, cookie_duration, cost_flat, cost_perc, cost_type, created_by, date_added, date_expire, date_live, deduct_full_customer_commission, deduct_window, deleted, expire_offer, expire_program, expire_url, featured, geoip_group_redirect, groups, hidden, hide_payout_string, ip_conversion_group, ip_conversion_limit, ip_conversion_limit_flag, ip_lookup, ip_uniqueness_seconds, landing_pages, marketing_types, min_deduct_date, mobile_landing_page, '''name''', no_personal_member_info, offer, '''offer_description''', offer_group, offer_limit, offer_limit_addition, offer_limit_deduction, offer_note, offer_quantity, '''offerid''', pending_approval_lockout, prevent_cookie_dupes, remove_ocode, reuse_active, revenue_amount, revenue_click, revenue_conversion, revenue_impression, revenue_sale, revenue_type, status, subject_lines, suppress_continuity_pixels, suppress_conversion_pixels, thumb_last_modified, thumbnail_url, timezone, type, unauthorized_countries, unauthorized_countries_iso, unique_duration
**'''''optional'''''
**Comma separated list of data columns to return for each offer. If not specified, all details will be returned

*start
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to start at specific section of the result set.

*count
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to limit how many offers are returned in the result set.

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = Array(
'offerid' => '136',
//'name_like' => 'Offer',
//'name' => 'API TEST Offer 123',
'return_columns' => 'name, cost_type, advertiser, advertiser_username, conversion, continuity',
);

$data_string = http_build_query($data);
$url = 'http://domain/api/offer/get_details?'.$data_string;

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_HTTPGET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

*Response:
<pre>
Array
(
[result] => success
[message] => Offer Found
[offer_count] => 1
[offer_details] => Array
(
[136] => Array
(
[advertiser_username] => advertiser1
[advertiserid] => 6
[continuity] => 10.00
[conversion] => 10.00
[cost_type] => Per Conversion (dynamic from url)
[name] => advertiser1Offer2
[offerid] => 136
)

)

)
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Offer Get Details

2020-06-22T18:06:43Z

Offeritnick: /* GET /offer/get_details */

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /offer/get_details''' ***COMING SOON*** ==
'''Description'''
*API resource to get offer details

'''Resource URL'''
*<nowiki>http://domain/api/offer/get_details</nowiki>
*Replace domain with the Offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''This API requires either offerid, name, or name_like. If none are supplied, no results will be returned. If multiple are supplied, only one will be prioritized and used based on the order listed. (ex: if both offerid and name are supplied, only offerid will be used to do the lookup)''.'''

*offerid
**'''''type: string'''''
**'''''optional'''''
**Offerid or comma separated list of offerids to get details for

*name
**'''''type: string'''''
**'''''optional'''''
**Exact name of the offer to get details for

*name_like
**'''''type: string'''''
**'''''optional'''''
**Name fragment of the offer(s) to get details for

*return_columns
**'''''type: string'''''
**'''''allowed values:''''' active, admin_threshold_email, adv_cpm_click, advertiser_username, advertiserid, affiliate_payout, allow_s2s_ip, allowed_hours, allowed_states, approved, authorized_countries, authorized_countries_iso, categories, commission, commission_description, conversion, conversion_cap, conversion_trans_type, continuity, conversion_type, cookie_duration, cost_flat, cost_perc, cost_type, created_by, date_added, date_expire, date_live, deduct_full_customer_commission, deduct_window, deleted, expire_offer, expire_program, expire_url, featured, geoip_group_redirect, groups, hidden, hide_payout_string, ip_conversion_group, ip_conversion_limit, ip_conversion_limit_flag, ip_lookup, ip_uniqueness_seconds, landing_pages, marketing_types, min_deduct_date, mobile_landing_page, '''name''', no_personal_member_info, offer, '''offer_description''', offer_group, offer_limit, offer_limit_addition, offer_limit_deduction, offer_note, offer_quantity, '''offerid''', pending_approval_lockout, prevent_cookie_dupes, remove_ocode, reuse_active, revenue_amount, revenue_click, revenue_conversion, revenue_impression, revenue_sale, revenue_type, status, subject_lines, suppress_continuity_pixels, suppress_conversion_pixels, thumb_last_modified, thumbnail_url, timezone, type, unauthorized_countries, unauthorized_countries_iso, unique_duration
**'''''optional'''''
**Comma separated list of data columns to return for each offer. If not specified, all details will be returned

*start
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to start at specific section of the result set.

*count
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to limit how many offers are returned in the result set.

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = Array(
'offerid' => '136',
//'name_like' => 'Offer',
//'name' => 'API TEST Offer 123',
'return_columns' => 'name, cost_type, advertiser, advertiser_username, conversion, continuity',
);

$data_string = http_build_query($data);
$url = 'http://domain/api/offer/get_details?'.$data_string;

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_HTTPGET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

*Response:
<pre>
Array
(
[result] => success
[message] => Offer Found
[offer_count] => 1
[offer_details] => Array
(
[136] => Array
(
[advertiser_username] => advertiser1
[advertiserid] => 6
[continuity] => 10.00
[conversion] => 10.00
[cost_type] => Per Conversion (dynamic from url)
[name] => advertiser1Offer2
[offerid] => 136
)

)

)
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Offer Get Details

2020-06-22T18:06:11Z

Offeritnick: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''GET /offer/get_details''' == '''Description''' *API resource to get offer details '''Resource URL''' *<nowiki>http..."

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /offer/get_details''' ==
'''Description'''
*API resource to get offer details

'''Resource URL'''
*<nowiki>http://domain/api/offer/get_details</nowiki>
*Replace domain with the Offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''This API requires either offerid, name, or name_like. If none are supplied, no results will be returned. If multiple are supplied, only one will be prioritized and used based on the order listed. (ex: if both offerid and name are supplied, only offerid will be used to do the lookup)''.'''

*offerid
**'''''type: string'''''
**'''''optional'''''
**Offerid or comma separated list of offerids to get details for

*name
**'''''type: string'''''
**'''''optional'''''
**Exact name of the offer to get details for

*name_like
**'''''type: string'''''
**'''''optional'''''
**Name fragment of the offer(s) to get details for

*return_columns
**'''''type: string'''''
**'''''allowed values:''''' active, admin_threshold_email, adv_cpm_click, advertiser_username, advertiserid, affiliate_payout, allow_s2s_ip, allowed_hours, allowed_states, approved, authorized_countries, authorized_countries_iso, categories, commission, commission_description, conversion, conversion_cap, conversion_trans_type, continuity, conversion_type, cookie_duration, cost_flat, cost_perc, cost_type, created_by, date_added, date_expire, date_live, deduct_full_customer_commission, deduct_window, deleted, expire_offer, expire_program, expire_url, featured, geoip_group_redirect, groups, hidden, hide_payout_string, ip_conversion_group, ip_conversion_limit, ip_conversion_limit_flag, ip_lookup, ip_uniqueness_seconds, landing_pages, marketing_types, min_deduct_date, mobile_landing_page, '''name''', no_personal_member_info, offer, '''offer_description''', offer_group, offer_limit, offer_limit_addition, offer_limit_deduction, offer_note, offer_quantity, '''offerid''', pending_approval_lockout, prevent_cookie_dupes, remove_ocode, reuse_active, revenue_amount, revenue_click, revenue_conversion, revenue_impression, revenue_sale, revenue_type, status, subject_lines, suppress_continuity_pixels, suppress_conversion_pixels, thumb_last_modified, thumbnail_url, timezone, type, unauthorized_countries, unauthorized_countries_iso, unique_duration
**'''''optional'''''
**Comma separated list of data columns to return for each offer. If not specified, all details will be returned

*start
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to start at specific section of the result set.

*count
**'''''type: int'''''
**'''''optional'''''
** If the result set is large, you can use this to limit how many offers are returned in the result set.

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = Array(
'offerid' => '136',
//'name_like' => 'Offer',
//'name' => 'API TEST Offer 123',
'return_columns' => 'name, cost_type, advertiser, advertiser_username, conversion, continuity',
);

$data_string = http_build_query($data);
$url = 'http://domain/api/offer/get_details?'.$data_string;

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_HTTPGET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

*Response:
<pre>
Array
(
[result] => success
[message] => Offer Found
[offer_count] => 1
[offer_details] => Array
(
[136] => Array
(
[advertiser_username] => advertiser1
[advertiserid] => 6
[continuity] => 10.00
[conversion] => 10.00
[cost_type] => Per Conversion (dynamic from url)
[name] => advertiser1Offer2
[offerid] => 136
)

)

)
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Add Offer

2020-04-30T21:02:34Z

Offeritnick: /* Offer Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /offer/add_offer''' ==
'''Description'''
*add_offer adds a new offer

'''Resource URL'''
*<nowiki>http://domain/api/offer/add_offer</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*POST

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
=== '''Offer Parameters''' ===
*name
**'''''type: string'''''
**'''''required'''
**Offer Name
*offer_description
**'''''type: string'''''
**Description to display to affiliates
*hidden
**'''''type: bool'''''
**0 or 1. If set to 1, offer does not show up in the affiliate offer list.
*date_live
**'''''type: string'''''
**Time when offer should become available to affiliates. String to time on the string provided. Default is empty.
*date_expire
**'''''type: string'''''
**Time when offer should stop being available to affiliates. String to time on the string provided. Default is empty.
*featured
**'''''type: bool'''''
**Flags this as a featured offer. Default FALSE.
*expire_url
**'''''type: string'''''
**External URL to redirect traffic to if the offer is expired.
*expire_landing_pageid
**'''''type: string'''''
**ID of landing page to redirect traffic to if the offer is expired.
*no_personal_member_info
**'''''type: string'''''
**Prevent name and address information from being stored in the customer record
*subject_lines
**'''''type: string'''''
**Comma separated list of recommended subject lines for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled
*from_addresses
**'''''type: string'''''
**Comma separated list of recommended from addresses for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled
*ip_lookup
**'''''type: Bool'''''
** Set cookieless tracking to match on only IP instead of IP+Browser Details. Default FALSE.
*ip_uniqueness_seconds
**'''''type: int'''''
**Set the number of seconds before a repeat visit by the same visitor will trigger the 'unique' offer redirect contition. This does not affect them showing as unique in stats. Default is unset on the offer level and inheriting from the "Unique Visitor Time" configuration setting.
*offer_groups
**'''''type: int,string,array'''''
**Accepts an existing offer group id, comma separated list of group ids, or array of group ids to associate with this offer.
*marketing_types
**'''''type: int,string,array'''''
**Accepts an existing marketing type id, comma separated list of marketing type ids, or array of marketing type ids to associate with this offer.
*categories
**'''''type: int,string,array'''''
**Accepts an existing category id or category name, comma separated list of ids/names, or array of ids/names to associate with this offer. Creates new categories if a category name is passed that does not exist.
*authorized
**'''''type: string,array'''''
**Accepts a comma separated list or array of 2 letter country codes where traffic is authorized to use this offer. Defaults to the 'Default Authorized Countries' configuration setting.
*unauthorized
**'''''type: string,array'''''
**Accepts a comma separated list or array of 2 letter country codes where traffic is not authorized to use this offer. Defaults to the 'Default Unauthorized Countries' configuration setting.
If no authorized or unauthorized countries are set even after checking the network configurations, the offer is authorized for all countries by default.

==='''Advertiser Parameters'''===
*advertiserid
**'''''type: int'''''
**Loginid of advertiser account associated with this offer. Default none.
*advertiser_cost_type
**'''''type: string'''''
**'''''options:'''''
***conversion:flat amount per conversion
***dynamic_conversion:uses the revenue passed with the conversion
***sale:calculate a percentage of the gross sale amount reported by the advertiser
***click:a flat amount per click
***unique:a flat amount per unique click
**If there is an advertiser associated with this offer, how is offer revenue calculated. Default none.
*advertiser_cost_flat
**'''''type: string'''''
**Flat cost to advertisers. used with 'conversion','click','unique'
*advertiser_cost_perc
**'''''type: string'''''
**Percentage cost to advertiser used with 'sale'

==='''Fraud Prevention Parameters'''===
*ip_conversion_limit_flag
**'''''type: int'''''
**'''''options'''''
***0: Inherit from Network Configuration
***1: No Limit on this offer
***2: Specify Limimt on this offer
**Comma separated list of recommended from addresses for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled. Default 0.
*ip_conversion_limit
**'''''type: int'''''
**Number of conversions allowed per IP to this offer in any 24 hour time period. Only checked if ip_conversion_limit_flag=2. Default 0.
*ip_conversion_group
**'''''type: int'''''
**'''''options'''''
***0: This offer only
***x: Group id of any offer group.
**Controls the scope of ip_conversion_limit. Default is 0, this offer only. Specifying a group id will count all conversion for offers in that group
*prevent_cookie_dupes
**'''''type: Bool'''''
**Checks a cookie to block surfers that have already converted on this offer during the cookie lifetime. Default FALSE.
*pending_approval_lockout
**'''''type: int'''''
**Minimum number of seconds that must pass between a click and a conversion for that conversion to be automatically approved. While this setting is in effect, all conversions on this offer are treated as pending. If the lockout period has been reached, the system will record both a pending conversion and an approved conversion automatically. Default 0 to disable.

==='''Revenue Parameters'''===
*conversion_default
**'''''type: string'''''
**Amount used if none is specified in the conversion. Default none.
*conversion_default_type
**'''''type: int'''''
**'''''options'''''
***1:Revenue
***2:Gross
** Specify if the amount specified in conversion_default is revenue or gross. Default 1 for revenue
*continuity_default
**'''''type: int'''''
**Amount used if none is specified in the continuity. Default none.
*continuity_default_type
**'''''type: string'''''
**'''''options'''''
***1:Revenue
***2:Gross
** Specify if the amount specified in continuity_default is revenue or gross. Default 1 for revenue

==='''Commission Parameters'''===
*percentage_commission_source
**'''''type: int''''
**'''''options'''''
***0:Revenue
***1:Gross
** Specify whether revenue or gross should be used as the base when affiliate are paid a percentage. Default 0 for revenue
*hide_payout_string
**'''''type: bool''''
**Hide the automatically generated commission description and use the description in 'commission_description' instead.
*commission_description
**'''''type: string''''
**Custom description displayed to affiliates to explain how commissions are calculated for this offer.
*commission_type
**'''''type: string''''
**'''''options'''''
***cpa:Flat per CPA. Works with flat_amount_per_conversion and flat_amount_per_continuity
***cps:Percentage of Sale. Works with percentage_of_customer_conversion and percentage_of_customer_continuity
***click:Flat per Click. Works with flat_amount_per_click and flat_amount_per_visitor
***hybrid:Hybrid. Works with all fields.
**Specify what type of commission this offer will pay.
*flat_amount_per_click
**'''''type: decimal''''
** Flat commission paid for every raw click. Works with click or hybrid
*flat_amount_per_visitor
**'''''type: decimal''''
** Flat commission paid for every unique click. Works with click or hybrid
*flat_amount_per_conversion
**'''''type: decimal''''
** Flat commission paid for every conversion. Works with cpa or hybrid
*flat_amount_per_continuity
**'''''type: decimal''''
** Flat commission paid for every continuity. Works with cpa or hybrid
*percentage_of_customer_conversion
**'''''type: decimal''''
** Percentage of conversion revenue to pay as commission. Works with cps or hybrid
*percentage_of_customer_continuity
**'''''type: decimal''''
** Percentage of continuity revenue to pay as commission. Works with cps or hybrid
*retro_payout
**'''''type: bool''''
*All transactions for a customer will use the commission settings in place at the time of the first transaction.
*hide_deductions
**'''''type: bool''''
*Only show voids / chargebacks in affiliate statistics if they affected affiliate commissions.
*hide_continuities
**'''''type: bool''''
*Only show continuities in affiliate statistics if they affected affiliate commissions.
*hide_conversions
**'''''type: bool''''
*Only show conversions in affiliate statistics if they affected affiliate commissions.
*deduct_voids
**'''''type: bool''''
**When enabled, voids will reverse the commission paid to the affiliate on the original transaction that is being voided
*deduct_chargebacks
**'''''type: bool''''
**When enabled, chargebacks will reverse the commission paid to the affiliate on the original transaction that is being charged back
*min_deduct_date
**'''''type: string''''
**Date for stringtotime. Transactions before this date will never have their commissions removed by a void or chargeback.
*deduct_window
**'''''type: int''''
**If a void or chargeback is reported more than this many days after the original transaction, the affiliate will not have their commission removed even if deduct_voids or deduct_chargebacks is enabled.

=== '''Landing Page Parameters''' ===
*url
**'''''type: string'''''
**'''''required'''
**Landing Page url
*preview_url
**'''''type: string'''''
**Clean url to display to affiliates
*tracking_domain
**'''''type: string'''''
**One of your already defined tracking domains
*thumb_url
**'''''type: string'''''
**Url of offer thumbnail image.
*force_url
**'''''type: string'''''
**Url to screenshot for thumbnail.
*language
**'''''type: int''''
**id of one of your defined languages from the offers admin.
*conversion_type
**'''''type: string'''''
**'''''options: iframe,post,image'''''
**Type of conversion to use for this offer
*postback_ips
**'''''type: string'''''
**Comma separated list of ips that are allowed to post conversions to this offer. Default is no restriction
*hostnpost_ips
**'''''type: string'''''
**Comma separated list of ips that are allowed to post hostandpost conversions to this offer. Default is no restriction
*void_ips
**'''''type: string'''''
**Comma separated list of ips that are allowed to post voids to this offer. Default is deny all.
*private
**'''''type: bool'''''
**TRUE means the default landing page for the new offer will be private. Default is FALSE.
*requestable
**'''''type: bool'''''
**TRUE means the default landing page for the new offer will be requestable if it is also private. Default is FALSE.
*internal_desc
**'''''type: string'''''
**Landing page description for the new offer that is only in the admin interface. Default is empty.
*redirect_hash
**'''''type: string'''''
**Matching field for identifying what landing page to use when geo redirecting within an offer group. Default is empty.
*disable_url_sanitization
**'''''type: bool'''''
**Uses landing page url exactly as provided without encoding any invalid url characters. Default is false, encoding invalid url characters in the landing page.
*disable_deep_linking
**'''''type: bool'''''
**Discards any extra path and variables specified by the affilaite on the tracking link. Default is false, allowing the affiliate to affect the landing page url.

== '''Example Request''' ==

'''POST'''
<pre>
<nowiki>
http://domain/api/offer/add_offer
name=API TEST OFFER
url=http://example.com/?id=%%click_hash%%
preview_url=http://example.com/
authorized=DE,ES
advertiserid=1
advertiser_cost_type=conversion
advertiser_cost_flat=20
commission_type=201
flat_amount_per_conversion=15
flat_amount_per_continuity=5
</nowiki>
</pre>

*Response:
<pre>
{
"result":"Success",
"message":{
"landing_pageid":"432",
"offerid":"400"
}
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/offer/add_offer';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'name' => 'API TEST Offer',
'url' => 'http://example.com/?id=%%click_hash%%',
'preview_url' => 'http://example.com/',
'authorized' => 'DE,ES',
'advertiserid' => 1,
'advertiser_cost_type' => 'conversion',
'advertiser_cost_flat'=> 20,
'commission_type' => 201,
'flat_amount_per_conversion' => 15,
'flat_amount_per_continuity' => 5,
);

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Get Links

2020-04-21T18:11:48Z

Offeritnick:

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /affiliate/get_links''' ==
'''Description'''
*Gets all tracking links for an affiliate. Optionally lets you limit to a specific offer or landing page.

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/get_links</nowiki>

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*loginid
**'''''type: int'''''
**'''''required'''
** affiliate to get link for
*offerid
**'''''type: int'''''
** Optional offer to get link for
*landing_pageid
**'''''type: int'''''
** Optional landing page to get link for. Defaults to default lander for the offer.
*style
**'''''type: string'''''
**'''''options: encoded,ids,shortnames,tiny'''''
** Optional link style. Defaults to encoded.
*subaff
**'''''type: string'''''
** Optional subaff value. Defaults to none.
*subaff2
**'''''type: string'''''
** Optional subaff2 value. Defaults to none.
*subaff3
**'''''type: string'''''
** Optional subaff3 value. Defaults to none.
*subaff4
**'''''type: string'''''
** Optional subaff4 value. Defaults to none.
*subaff5
**'''''type: string'''''
** Optional subaff5 value. Defaults to none.
*subids
**'''''type: string'''''
** Optional comma separated list of subids. Defaults to none.
*_ocid
**'''''type: string'''''
** Optional click id value. Defaults to none.
*code_only
**'''''type: Bool'''''
** Optional - returns only the code from the tracking link. Defaults to full url.
*get_countries
**'''''type: Bool'''''
** Optional - return the authorized and unauthorized countries for each link.
*get_commission
**'''''type: Bool'''''
** Optional - return the commission string for each link.
*get_hidden
**'''''type: Int'''''
** Optional - 0 to return landing pages that are not hidden, 1 only hidden landing pages, 2 all. If not sent, will behave as if you passed 0 for only landing pages that are not hidden.
*get_hidden_offers
**'''''type: Int'''''
** Optional - 0 to return offers that are not hidden, 1 only hidden offers, 2 all offers. If not sent, will behave as if you passed 2 for all offers.

== '''Example Request''' ==

'''GET'''

<pre><nowiki>http://domain/api/affiliate/get_links?loginid=2&offerid=1&subaff=test&_ocid={token}
</nowiki></pre>

*Response:
<pre>
{
"result":"Success",
"message":[
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":425,
"Landing Page Name":"lp333",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjQyNS4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
},
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":304,
"Landing Page Name":"offerit offer",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjMwNC4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
}
]
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/affiliate/get_links';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'loginid' => 2,
'offerid' => 1,
'subaff' => 'test',
'_ocid' => '{token}'
);

$data_string = http_build_query($data);
$url .= '?'.$data_string;

curl_setopt($curl, CURLOPT_GET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Get Links

2020-04-20T23:01:25Z

Offeritnick: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /affiliate/get_links''' ==
'''Description'''
*Gets all tracking links for an affiliate. Optionally lets you limit to a specific offer or landing page.

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/get_links</nowiki>

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*loginid
**'''''type: int'''''
**'''''required'''
** affiliate to get link for
*offerid
**'''''type: int'''''
** Optional offer to get link for
*landing_pageid
**'''''type: int'''''
** Optional landing page to get link for. Defaults to default lander for the offer.
*style
**'''''type: string'''''
**'''''options: encoded,ids,shortnames,tiny'''''
** Optional link style. Defaults to encoded.
*subaff
**'''''type: string'''''
** Optional subaff value. Defaults to none.
*subaff2
**'''''type: string'''''
** Optional subaff2 value. Defaults to none.
*subaff3
**'''''type: string'''''
** Optional subaff3 value. Defaults to none.
*subaff4
**'''''type: string'''''
** Optional subaff4 value. Defaults to none.
*subaff5
**'''''type: string'''''
** Optional subaff5 value. Defaults to none.
*subids
**'''''type: string'''''
** Optional comma separated list of subids. Defaults to none.
*_ocid
**'''''type: string'''''
** Optional click id value. Defaults to none.
*code_only
**'''''type: Bool'''''
** Optional - returns only the code from the tracking link. Defaults to full url.
*get_countries
**'''''type: Bool'''''
** Optional - return the authorized and unauthorized countries for each link.
*get_commission
**'''''type: Bool'''''
** Optional - return the commission string for each link.
*get_hidden
**'''''type: Int'''''
** Optional - 0 to return landing pages that are not hidden, 1 only hidden landing pages, 2 all. If not sent, will behave as if you passed 0 for only landing pages that are not hidden.
*COMING SOON*
*get_hidden_offers
**'''''type: Int'''''
** Optional - 0 to return offers that are not hidden, 1 only hidden offers, 2 all offers. If not sent, will behave as if you passed 2 for all offers.

== '''Example Request''' ==

'''GET'''

<pre><nowiki>http://domain/api/affiliate/get_links?loginid=2&offerid=1&subaff=test&_ocid={token}
</nowiki></pre>

*Response:
<pre>
{
"result":"Success",
"message":[
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":425,
"Landing Page Name":"lp333",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjQyNS4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
},
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":304,
"Landing Page Name":"offerit offer",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjMwNC4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
}
]
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/affiliate/get_links';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'loginid' => 2,
'offerid' => 1,
'subaff' => 'test',
'_ocid' => '{token}'
);

$data_string = http_build_query($data);
$url .= '?'.$data_string;

curl_setopt($curl, CURLOPT_GET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit Currency Exchange Rates

2020-04-20T18:40:25Z

Offeritnick: /* Automatic Updates *COMING SOON* */

{{Offerit Manual|show_setup_section=true}}

Ideally, the amounts reported back to Offerit should be a converted amount to your base currency. However, offerit can be used for converting amounts instead. When sending a postback to offerit for a different currency, we will use the exchange rate configured in your Offerit install at the time we receive the postback/pixel call for a transaction. With these details in mind, here are a few potential issues that can occur when using Offerit for converting currencies:
* The exchange rate used by the processor for the transaction does not match up with the exchange rate configured in offerit when the postback/pixel is received
* The exchange rate our source is reporting does not match the rate you want or expect
* The source api fails to return the latest rates

= Automatic Updates =
By default Offerit updates conversion rates once a day from https://exchangeratesapi.io/. We have options to decrease this frequency to weekly if you choose. If you would like to update more frequently than this, you can turn OFF the automatic update configuration and use our [[Offerit_REST_API_Set_Currency_Exchange_Rates|Set Currency Exchange Rates API]] to send exchange rate updates.

== Automatic Update Configurations ==
* Automatic Exchange Rate Updates - Turn automatic updates for currency exchange rates on or off.
* Automatic Update Currency List - You can use a comma separated list if you only want to opt-in to automatic updates for specific currencies.
* Automatic Update Exclude Currency List - You can use a comma separated list if you want to opt-out of automatic updates for specific currencies.
* Automatic Update Schedule - Daily is our default, but you can choose weekly updates on a specific day of the week as well.
* Exchange Rate Source - The source API you would like to receive automatic updates from.
* Open Exchange Rates App ID - If you choose "Open Exchange Rates" as your Exchange Rate Soruce, you can use this to set a personal "App ID" for making the API calls to their system.

Offerit REST API Get Links

2020-04-20T18:39:44Z

Offeritnick:

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /affiliate/get_links''' ==
'''Description'''
*Gets all tracking links for an affiliate. Optionally lets you limit to a specific offer or landing page.

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/get_links</nowiki>

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*loginid
**'''''type: int'''''
**'''''required'''
** affiliate to get link for
*offerid
**'''''type: int'''''
** Optional offer to get link for
*landing_pageid
**'''''type: int'''''
** Optional landing page to get link for. Defaults to default lander for the offer.
*style
**'''''type: string'''''
**'''''options: encoded,ids,shortnames,tiny'''''
** Optional link style. Defaults to encoded.
*subaff
**'''''type: string'''''
** Optional subaff value. Defaults to none.
*subaff2
**'''''type: string'''''
** Optional subaff2 value. Defaults to none.
*subaff3
**'''''type: string'''''
** Optional subaff3 value. Defaults to none.
*subaff4
**'''''type: string'''''
** Optional subaff4 value. Defaults to none.
*subaff5
**'''''type: string'''''
** Optional subaff5 value. Defaults to none.
*subids
**'''''type: string'''''
** Optional comma separated list of subids. Defaults to none.
*_ocid
**'''''type: string'''''
** Optional click id value. Defaults to none.
*code_only
**'''''type: Bool'''''
** Optional - returns only the code from the tracking link. Defaults to full url.
*get_countries
**'''''type: Bool'''''
** Optional - return the authorized and unauthorized countries for each link.
*get_commission
**'''''type: Bool'''''
** Optional - return the commission string for each link.
*get_hidden
**'''''type: Int'''''
** Optional - 0 to return not hidden lps, 1 only hidden lps, 2 all lps

== '''Example Request''' ==

'''GET'''

<pre><nowiki>http://domain/api/affiliate/get_links?loginid=2&offerid=1&subaff=test&_ocid={token}
</nowiki></pre>

*Response:
<pre>
{
"result":"Success",
"message":[
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":425,
"Landing Page Name":"lp333",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjQyNS4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
},
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":304,
"Landing Page Name":"offerit offer",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjMwNC4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
}
]
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/affiliate/get_links';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'loginid' => 2,
'offerid' => 1,
'subaff' => 'test',
'_ocid' => '{token}'
);

$data_string = http_build_query($data);
$url .= '?'.$data_string;

curl_setopt($curl, CURLOPT_GET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit Postback Examples

2020-04-01T22:10:41Z

Offeritnick: /* Optional Parameters */

{{Offerit Manual|show_setup_section=true}}
= Event Postbacks =
Offerit uses the 'process_pixel.php' script to record events. Below are the examples of different events you may need to send postbacks for, and what parameters are required to record each event type in Offerit.

== Conversion Postback ==
The first transaction for a customer is considered a "conversion". For conversions, the only required field is the 'click_hash' which was generated for a surfer when they went through one of our tracking links:
<pre>http://example.offerit.com/signup/process_pixel.php?click_hash={CLICK_HASH}</pre>

'''Although sending just click_hash will work for recording a conversion event, here are some optional parameters that are commonly sent:'''
*'' subscription_id ''- the Subscription ID is generally a unique customer identifier from your system. Sending a subscription_id allows you to tie future events to the same cusotmer record
*'' amount ''- This parameter is the amount of revenue your network made for the event. It will override the "Conversion Amount" defined on the offer. This allows you to record transactions for any amount rather than just the default amount for the offer. This value should be sent in the base currency for your network. The default is USD, but you can check your network's default in the Config Admin -> Currency - All page. This value should also be in decimal format. For example, if a transaction amount is $9.95, the amount should be sent as "&amount=9.95"

== Continuity Postback ==
Any transaction for a customer after the initial conversion is considered a "continuity". (Ex: Recurring Subscriptions may have periodic continuity transactions sent)
<pre>http://example.offerit.com/signup/process_pixel.php?subscription_id={USER_ID}&orderid={TRANSACTION_ID}</pre>

For continuities, you must send at minimum the subscription_id (same as from conversion postback), and the orderid:
*'' subscription_id ''- the Subscription ID is generally a unique customer identifier from your system. Sending a subscription_id allows you to tie future events to the same cusotmer record
*'' orderid ''- The Order ID is generally a unique identifier for the transaction from your system. Sending us an identifier for your transactions helps us to ensure that if you accidentally send the same transaction postback multiple times, we will only record it once. It also helps with advertiser communication to find and reference transactions if disputes arise.

== Goal Postback ==
For flexibility, Offerit allows you to define your own custom events called "Goals". A common example that is added as a goal is a free registration or signup. When setting up a new Goal, you will be asked to define a "Goal Slug" (ex: freereg). This is slug is what you add to your postbacks to indicate that it is not a normal conversion event, but rather a custom event:
<pre>http://example.offerit.com/signup/process_pixel.php?click_hash={CLICK_HASH}&subscription_id={USER_ID}&goal_slug={GOAL_SLUG}</pre>

Goal postbacks require the following fields:
*'' click_hash '' - This is the same click_hash generated for a surfer when they go through our tracking links. This field is only required if this is the first postback being sent for the customer (before conversion)
*'' subscription_id '' - If this is the first post for the customer, this field will set the customer's ID from your system in Offerit so it can be used for future postbacks instead of click_hash. If this is a follow up post, this will be used to look up the existing customer to insert the Goal transaction in the same customer record.
*'' goal_slug '' - This is the "Goal Slug" defined when adding a new Goal. You can look up your existing goal slugs from the Offers Admin -> Manage Goals page. This indicates what type of transaction you are trying to report.
*'' orderid '' - This field is only required if this is NOT the first postback being sent for the customer (no click_hash). The Order ID is generally a unique identifier for the transaction from your system. Sending us an identifier for your transactions helps us to ensure that if you accidentally send the same transaction postback multiple times, we will only record it once. It also helps with advertiser communication to find and reference transactions if disputes arise.

You can optionally ask us to enable a setting which will require "orderid" for cases where the goal postback is the first postback for a customer.

= Optional Parameters =
The following paremeters can also be sent in your postbacks to be recorded with the customer record:
*'' amount ''- This parameter is the amount of revenue your network made for the event. If the amount for a transaction doesn't match what's defined as the default amount for the event on the offer, you can send this parameter to set the proper transaction amount to be recorded. This value should be sent in the base currency for your network. The default is USD, but you can check your network's default in the Config Admin -> Currency - All page. This value should also be in decimal format. For example, if a transaction amount is $9.95, the amount should be sent as "&amount=9.95". If you have default amounts set on the offer, and you want a $0 transaction, you must pass amount as "zero".
*'' currency ''- This paremeter defines the currency that the "amount" parameter is sent in. The possible 3 letter currency values are listed on the Config Admin -> Currency - All page. This page is also where you would need to manually maintain conversion rates for your install. When Offerit receives a transaction in a currency that is not your base currency, it will automatically convert the amount to the equivalent amount in your base currency for reporting.
*'' username ''
*'' password ''
*'' email ''
*'' ip ''
*'' firstname ''
*'' lastname ''
*'' address1 ''
*'' address2 ''
*'' zip ''
*'' city ''
*'' state ''
*'' country ''
*'' shipping_firstname ''
*'' shipping_lastname ''
*'' shipping_address1 ''
*'' shipping_address2 ''
*'' shipping_zip ''
*'' shipping_city ''
*'' shipping_state ''
*'' shipping_country ''
*'' phone ''
*'' custom1 '' - custom value to record with a customer
*'' custom2 ''
*'' custom3 ''
*'' custom4 ''
*'' custom5 ''
'''*COMING SOON*'''
*'' trans_custom1 '' - custom value to record with a transaction. -1 is a reserved value and should not be used.
*'' trans_custom2 ''
*'' trans_custom3 ''
*'' trans_custom4 ''
*'' trans_custom5 ''
''' If you send postbacks with different personal data for the same customer, Offerit will take the latest information sent and update the customer record in question. '''

Offerit REST API Get Links

2020-03-26T16:01:23Z

Offeritnick: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /affiliate/get_links''' ==
'''Description'''
*Gets all tracking links for an affiliate. Optionally lets you limit to a specific offer or landing page.

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/get_links</nowiki>

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*loginid
**'''''type: int'''''
**'''''required'''
** affiliate to get link for
*offerid
**'''''type: int'''''
** Optional offer to get link for
*landing_pageid
**'''''type: int'''''
** Optional landing page to get link for. Defaults to default lander for the offer.
*style
**'''''type: string'''''
**'''''options: encoded,ids,shortnames,tiny'''''
** Optional link style. Defaults to encoded.
*subaff
**'''''type: string'''''
** Optional subaff value. Defaults to none.
*subaff2
**'''''type: string'''''
** Optional subaff2 value. Defaults to none.
*subaff3
**'''''type: string'''''
** Optional subaff3 value. Defaults to none.
*subaff4
**'''''type: string'''''
** Optional subaff4 value. Defaults to none.
*subaff5
**'''''type: string'''''
** Optional subaff5 value. Defaults to none.
*subids
**'''''type: string'''''
** Optional comma separated list of subids. Defaults to none.
*_ocid
**'''''type: string'''''
** Optional click id value. Defaults to none.
*code_only
**'''''type: Bool'''''
** Optional - returns only the code from the tracking link. Defaults to full url.
*get_countries
**'''''type: Bool'''''
** Optional - return the authorized and unauthorized countries for each link.
* COMING SOON *
*get_commission
**'''''type: Bool'''''
** Optional - return the commission string for each link.
*get_hidden
**'''''type: Int'''''
** Optional - 0 to return not hidden lps, 1 only hidden lps, 2 all lps

== '''Example Request''' ==

'''GET'''

<pre><nowiki>http://domain/api/affiliate/get_links?loginid=2&offerid=1&subaff=test&_ocid={token}
</nowiki></pre>

*Response:
<pre>
{
"result":"Success",
"message":[
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":425,
"Landing Page Name":"lp333",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjQyNS4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
},
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":304,
"Landing Page Name":"offerit offer",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjMwNC4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
}
]
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/affiliate/get_links';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'loginid' => 2,
'offerid' => 1,
'subaff' => 'test',
'_ocid' => '{token}'
);

$data_string = http_build_query($data);
$url .= '?'.$data_string;

curl_setopt($curl, CURLOPT_GET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Get Links

2020-03-26T14:44:26Z

Offeritnick:

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /affiliate/get_links''' ==
'''Description'''
*Gets all tracking links for an affiliate. Optionally lets you limit to a specific offer or landing page.

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/get_links</nowiki>

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*loginid
**'''''type: int'''''
**'''''required'''
** affiliate to get link for
*offerid
**'''''type: int'''''
** Optional offer to get link for
*landing_pageid
**'''''type: int'''''
** Optional landing page to get link for. Defaults to default lander for the offer.
*style
**'''''type: string'''''
**'''''options: encoded,ids,shortnames,tiny'''''
** Optional link style. Defaults to encoded.
*subaff
**'''''type: string'''''
** Optional subaff value. Defaults to none.
*subaff2
**'''''type: string'''''
** Optional subaff2 value. Defaults to none.
*subaff3
**'''''type: string'''''
** Optional subaff3 value. Defaults to none.
*subaff4
**'''''type: string'''''
** Optional subaff4 value. Defaults to none.
*subaff5
**'''''type: string'''''
** Optional subaff5 value. Defaults to none.
*subids
**'''''type: string'''''
** Optional comma separated list of subids. Defaults to none.
*_ocid
**'''''type: string'''''
** Optional click id value. Defaults to none.
*code_only
**'''''type: Bool'''''
** Optional - returns only the code from the tracking link. Defaults to full url.
*get_countries
**'''''type: Bool'''''
** Optional - return the authorized and unauthorized countries for each link.
*get_commission
**'''''type: Bool'''''
** Optional - return the commission string for each link.
*get_hidden
**'''''type: Int'''''
** Optional - 0 to return not hidden lps, 1 only hidden lps, 2 all lps

== '''Example Request''' ==

'''GET'''

<pre><nowiki>http://domain/api/affiliate/get_links?loginid=2&offerid=1&subaff=test&_ocid={token}
</nowiki></pre>

*Response:
<pre>
{
"result":"Success",
"message":[
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":425,
"Landing Page Name":"lp333",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjQyNS4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
},
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":304,
"Landing Page Name":"offerit offer",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjMwNC4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
}
]
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/affiliate/get_links';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'loginid' => 2,
'offerid' => 1,
'subaff' => 'test',
'_ocid' => '{token}'
);

$data_string = http_build_query($data);
$url .= '?'.$data_string;

curl_setopt($curl, CURLOPT_GET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Add Offer

2020-02-13T19:43:59Z

Offeritnick: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /offer/add_offer''' ==
'''Description'''
*add_offer adds a new offer

'''Resource URL'''
*<nowiki>http://domain/api/offer/add_offer</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*POST

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
=== '''Offer Parameters''' ===
*name
**'''''type: string'''''
**'''''required'''
**Offer Name
*description
**'''''type: string'''''
**Description to display to affiliates
*hidden
**'''''type: bool'''''
**0 or 1. If set to 1, offer does not show up in the affiliate offer list.
*date_live
**'''''type: string'''''
**Time when offer should become available to affiliates. String to time on the string provided. Default is empty.
*date_expire
**'''''type: string'''''
**Time when offer should stop being available to affiliates. String to time on the string provided. Default is empty.
*featured
**'''''type: bool'''''
**Flags this as a featured offer. Default FALSE.
*expire_url
**'''''type: string'''''
**External URL to redirect traffic to if the offer is expired.
*expire_landing_pageid
**'''''type: string'''''
**ID of landing page to redirect traffic to if the offer is expired.
*no_personal_member_info
**'''''type: string'''''
**Prevent name and address information from being stored in the customer record
*subject_lines
**'''''type: string'''''
**Comma separated list of recommended subject lines for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled
*from_addresses
**'''''type: string'''''
**Comma separated list of recommended from addresses for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled
*ip_lookup
**'''''type: Bool'''''
** Set cookieless tracking to match on only IP instead of IP+Browser Details. Default FALSE.
*ip_uniqueness_seconds
**'''''type: int'''''
**Set the number of seconds before a repeat visit by the same visitor will trigger the 'unique' offer redirect contition. This does not affect them showing as unique in stats. Default is unset on the offer level and inheriting from the "Unique Visitor Time" configuration setting.
*offer_groups
**'''''type: int,string,array'''''
**Accepts an existing offer group id, comma separated list of group ids, or array of group ids to associate with this offer.
*marketing_types
**'''''type: int,string,array'''''
**Accepts an existing marketing type id, comma separated list of marketing type ids, or array of marketing type ids to associate with this offer.
*categories
**'''''type: int,string,array'''''
**Accepts an existing category id or category name, comma separated list of ids/names, or array of ids/names to associate with this offer. Creates new categories if a category name is passed that does not exist.
*authorized
**'''''type: string,array'''''
**Accepts a comma separated list or array of 2 letter country codes where traffic is authorized to use this offer. Defaults to the 'Default Authorized Countries' configuration setting.
*unauthorized
**'''''type: string,array'''''
**Accepts a comma separated list or array of 2 letter country codes where traffic is not authorized to use this offer. Defaults to the 'Default Unauthorized Countries' configuration setting.
If no authorized or unauthorized countries are set even after checking the network configurations, the offer is authorized for all countries by default.

==='''Advertiser Parameters'''===
*advertiserid
**'''''type: int'''''
**Loginid of advertiser account associated with this offer. Default none.
*advertiser_cost_type
**'''''type: string'''''
**'''''options:'''''
***conversion:flat amount per conversion
***dynamic_conversion:uses the revenue passed with the conversion
***sale:calculate a percentage of the gross sale amount reported by the advertiser
***click:a flat amount per click
***unique:a flat amount per unique click
**If there is an advertiser associated with this offer, how is offer revenue calculated. Default none.
*advertiser_cost_flat
**'''''type: string'''''
**Flat cost to advertisers. used with 'conversion','click','unique'
*advertiser_cost_perc
**'''''type: string'''''
**Percentage cost to advertiser used with 'sale'

==='''Fraud Prevention Parameters'''===
*ip_conversion_limit_flag
**'''''type: int'''''
**'''''options'''''
***0: Inherit from Network Configuration
***1: No Limit on this offer
***2: Specify Limimt on this offer
**Comma separated list of recommended from addresses for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled. Default 0.
*ip_conversion_limit
**'''''type: int'''''
**Number of conversions allowed per IP to this offer in any 24 hour time period. Only checked if ip_conversion_limit_flag=2. Default 0.
*ip_conversion_group
**'''''type: int'''''
**'''''options'''''
***0: This offer only
***x: Group id of any offer group.
**Controls the scope of ip_conversion_limit. Default is 0, this offer only. Specifying a group id will count all conversion for offers in that group
*prevent_cookie_dupes
**'''''type: Bool'''''
**Checks a cookie to block surfers that have already converted on this offer during the cookie lifetime. Default FALSE.
*pending_approval_lockout
**'''''type: int'''''
**Minimum number of seconds that must pass between a click and a conversion for that conversion to be automatically approved. While this setting is in effect, all conversions on this offer are treated as pending. If the lockout period has been reached, the system will record both a pending conversion and an approved conversion automatically. Default 0 to disable.

==='''Revenue Parameters'''===
*conversion_default
**'''''type: string'''''
**Amount used if none is specified in the conversion. Default none.
*conversion_default_type
**'''''type: int'''''
**'''''options'''''
***1:Revenue
***2:Gross
** Specify if the amount specified in conversion_default is revenue or gross. Default 1 for revenue
*continuity_default
**'''''type: int'''''
**Amount used if none is specified in the continuity. Default none.
*continuity_default_type
**'''''type: string'''''
**'''''options'''''
***1:Revenue
***2:Gross
** Specify if the amount specified in continuity_default is revenue or gross. Default 1 for revenue

==='''Commission Parameters'''===
*percentage_commission_source
**'''''type: int''''
**'''''options'''''
***0:Revenue
***1:Gross
** Specify whether revenue or gross should be used as the base when affiliate are paid a percentage. Default 0 for revenue
*hide_payout_string
**'''''type: bool''''
**Hide the automatically generated commission description and use the description in 'commission_description' instead.
*commission_description
**'''''type: string''''
**Custom description displayed to affiliates to explain how commissions are calculated for this offer.
*commission_type
**'''''type: string''''
**'''''options'''''
***cpa:Flat per CPA. Works with flat_amount_per_conversion and flat_amount_per_continuity
***cps:Percentage of Sale. Works with percentage_of_customer_conversion and percentage_of_customer_continuity
***click:Flat per Click. Works with flat_amount_per_click and flat_amount_per_visitor
***hybrid:Hybrid. Works with all fields.
**Specify what type of commission this offer will pay.
*flat_amount_per_click
**'''''type: decimal''''
** Flat commission paid for every raw click. Works with click or hybrid
*flat_amount_per_visitor
**'''''type: decimal''''
** Flat commission paid for every unique click. Works with click or hybrid
*flat_amount_per_conversion
**'''''type: decimal''''
** Flat commission paid for every conversion. Works with cpa or hybrid
*flat_amount_per_continuity
**'''''type: decimal''''
** Flat commission paid for every continuity. Works with cpa or hybrid
*percentage_of_customer_conversion
**'''''type: decimal''''
** Percentage of conversion revenue to pay as commission. Works with cps or hybrid
*percentage_of_customer_continuity
**'''''type: decimal''''
** Percentage of continuity revenue to pay as commission. Works with cps or hybrid
*retro_payout
**'''''type: bool''''
*All transactions for a customer will use the commission settings in place at the time of the first transaction.
*hide_deductions
**'''''type: bool''''
*Only show voids / chargebacks in affiliate statistics if they affected affiliate commissions.
*hide_continuities
**'''''type: bool''''
*Only show continuities in affiliate statistics if they affected affiliate commissions.
*hide_conversions
**'''''type: bool''''
*Only show conversions in affiliate statistics if they affected affiliate commissions.
*deduct_voids
**'''''type: bool''''
**When enabled, voids will reverse the commission paid to the affiliate on the original transaction that is being voided
*deduct_chargebacks
**'''''type: bool''''
**When enabled, chargebacks will reverse the commission paid to the affiliate on the original transaction that is being charged back
*min_deduct_date
**'''''type: string''''
**Date for stringtotime. Transactions before this date will never have their commissions removed by a void or chargeback.
*deduct_window
**'''''type: int''''
**If a void or chargeback is reported more than this many days after the original transaction, the affiliate will not have their commission removed even if deduct_voids or deduct_chargebacks is enabled.

=== '''Landing Page Parameters''' ===
*url
**'''''type: string'''''
**'''''required'''
**Landing Page url
*preview_url
**'''''type: string'''''
**Clean url to display to affiliates
*tracking_domain
**'''''type: string'''''
**One of your already defined tracking domains
*thumb_url
**'''''type: string'''''
**Url of offer thumbnail image.
*force_url
**'''''type: string'''''
**Url to screenshot for thumbnail.
*language
**'''''type: int''''
**id of one of your defined languages from the offers admin.
*conversion_type
**'''''type: string'''''
**'''''options: iframe,post,image'''''
**Type of conversion to use for this offer
*postback_ips
**'''''type: string'''''
**Comma separated list of ips that are allowed to post conversions to this offer. Default is no restriction
*hostnpost_ips
**'''''type: string'''''
**Comma separated list of ips that are allowed to post hostandpost conversions to this offer. Default is no restriction
*void_ips
**'''''type: string'''''
**Comma separated list of ips that are allowed to post voids to this offer. Default is deny all.
*private
**'''''type: bool'''''
**TRUE means the default landing page for the new offer will be private. Default is FALSE.
*requestable
**'''''type: bool'''''
**TRUE means the default landing page for the new offer will be requestable if it is also private. Default is FALSE.
*internal_desc
**'''''type: string'''''
**Landing page description for the new offer that is only in the admin interface. Default is empty.
*redirect_hash
**'''''type: string'''''
**Matching field for identifying what landing page to use when geo redirecting within an offer group. Default is empty.
*disable_url_sanitization
**'''''type: bool'''''
**Uses landing page url exactly as provided without encoding any invalid url characters. Default is false, encoding invalid url characters in the landing page.
*disable_deep_linking
**'''''type: bool'''''
**Discards any extra path and variables specified by the affilaite on the tracking link. Default is false, allowing the affiliate to affect the landing page url.

== '''Example Request''' ==

'''POST'''
<pre>
<nowiki>
http://domain/api/offer/add_offer
name=API TEST OFFER
url=http://example.com/?id=%%click_hash%%
preview_url=http://example.com/
authorized=DE,ES
advertiserid=1
advertiser_cost_type=conversion
advertiser_cost_flat=20
commission_type=201
flat_amount_per_conversion=15
flat_amount_per_continuity=5
</nowiki>
</pre>

*Response:
<pre>
{
"result":"Success",
"message":{
"landing_pageid":"432",
"offerid":"400"
}
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/offer/add_offer';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'name' => 'API TEST Offer',
'url' => 'http://example.com/?id=%%click_hash%%',
'preview_url' => 'http://example.com/',
'authorized' => 'DE,ES',
'advertiserid' => 1,
'advertiser_cost_type' => 'conversion',
'advertiser_cost_flat'=> 20,
'commission_type' => 201,
'flat_amount_per_conversion' => 15,
'flat_amount_per_continuity' => 5,
);

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit Postback Examples

2019-12-12T22:39:47Z

Offeritnick:

{{Offerit Manual|show_setup_section=true}}
= Event Postbacks =
Offerit uses the 'process_pixel.php' script to record events. Below are the examples of different events you may need to send postbacks for, and what parameters are required to record each event type in Offerit.

== Conversion Postback ==
The first transaction for a customer is considered a "conversion". For conversions, the only required field is the 'click_hash' which was generated for a surfer when they went through one of our tracking links:
<pre>http://example.offerit.com/signup/process_pixel.php?click_hash={CLICK_HASH}</pre>

'''Although sending just click_hash will work for recording a conversion event, here are some optional parameters that are commonly sent:'''
*'' subscription_id ''- the Subscription ID is generally a unique customer identifier from your system. Sending a subscription_id allows you to tie future events to the same cusotmer record
*'' amount ''- This parameter is the amount of revenue your network made for the event. It will override the "Conversion Amount" defined on the offer. This allows you to record transactions for any amount rather than just the default amount for the offer. This value should be sent in the base currency for your network. The default is USD, but you can check your network's default in the Config Admin -> Currency - All page. This value should also be in decimal format. For example, if a transaction amount is $9.95, the amount should be sent as "&amount=9.95"

== Continuity Postback ==
Any transaction for a customer after the initial conversion is considered a "continuity". (Ex: Recurring Subscriptions may have periodic continuity transactions sent)
<pre>http://example.offerit.com/signup/process_pixel.php?subscription_id={USER_ID}&orderid={TRANSACTION_ID}</pre>

For continuities, you must send at minimum the subscription_id (same as from conversion postback), and the orderid:
*'' subscription_id ''- the Subscription ID is generally a unique customer identifier from your system. Sending a subscription_id allows you to tie future events to the same cusotmer record
*'' orderid ''- The Order ID is generally a unique identifier for the transaction from your system. Sending us an identifier for your transactions helps us to ensure that if you accidentally send the same transaction postback multiple times, we will only record it once. It also helps with advertiser communication to find and reference transactions if disputes arise.

== Goal Postback ==
For flexibility, Offerit allows you to define your own custom events called "Goals". A common example that is added as a goal is a free registration or signup. When setting up a new Goal, you will be asked to define a "Goal Slug" (ex: freereg). This is slug is what you add to your postbacks to indicate that it is not a normal conversion event, but rather a custom event:
<pre>http://example.offerit.com/signup/process_pixel.php?click_hash={CLICK_HASH}&subscription_id={USER_ID}&goal_slug={GOAL_SLUG}</pre>

Goal postbacks require the following fields:
*'' click_hash '' - This is the same click_hash generated for a surfer when they go through our tracking links. This field is only required if this is the first postback being sent for the customer (before conversion)
*'' subscription_id '' - If this is the first post for the customer, this field will set the customer's ID from your system in Offerit so it can be used for future postbacks instead of click_hash. If this is a follow up post, this will be used to look up the existing customer to insert the Goal transaction in the same customer record.
*'' goal_slug '' - This is the "Goal Slug" defined when adding a new Goal. You can look up your existing goal slugs from the Offers Admin -> Manage Goals page. This indicates what type of transaction you are trying to report.
*'' orderid '' - This field is only required if this is NOT the first postback being sent for the customer (no click_hash). The Order ID is generally a unique identifier for the transaction from your system. Sending us an identifier for your transactions helps us to ensure that if you accidentally send the same transaction postback multiple times, we will only record it once. It also helps with advertiser communication to find and reference transactions if disputes arise.

You can optionally ask us to enable a setting which will require "orderid" for cases where the goal postback is the first postback for a customer.

= Optional Parameters =
The following paremeters can also be sent in your postbacks to be recorded with the customer record:
*'' amount ''- This parameter is the amount of revenue your network made for the event. If the amount for a transaction doesn't match what's defined as the default amount for the event on the offer, you can send this parameter to set the proper transaction amount to be recorded. This value should be sent in the base currency for your network. The default is USD, but you can check your network's default in the Config Admin -> Currency - All page. This value should also be in decimal format. For example, if a transaction amount is $9.95, the amount should be sent as "&amount=9.95". If you have default amounts set on the offer, and you want a $0 transaction, you must pass amount as "zero".
*'' currency ''- This paremeter defines the currency that the "amount" parameter is sent in. The possible 3 letter currency values are listed on the Config Admin -> Currency - All page. This page is also where you would need to manually maintain conversion rates for your install. When Offerit receives a transaction in a currency that is not your base currency, it will automatically convert the amount to the equivalent amount in your base currency for reporting.
*'' username ''
*'' password ''
*'' email ''
*'' ip ''
*'' firstname ''
*'' lastname ''
*'' address1 ''
*'' address2 ''
*'' zip ''
*'' city ''
*'' state ''
*'' country ''
*'' shipping_firstname ''
*'' shipping_lastname ''
*'' shipping_address1 ''
*'' shipping_address2 ''
*'' shipping_zip ''
*'' shipping_city ''
*'' shipping_state ''
*'' shipping_country ''
*'' phone ''
*'' custom1 ''
*'' custom2 ''
*'' custom3 ''
*'' custom4 ''
*'' custom5 ''
'''*COMING SOON*'''
*'' trans_custom1 '' - custom value to record with a transaction. -1 is a reserved value and should not be used.
*'' trans_custom2 ''
*'' trans_custom3 ''
*'' trans_custom4 ''
*'' trans_custom5 ''
''' If you send postbacks with different personal data for the same customer, Offerit will take the latest information sent and update the customer record in question. '''

Offerit REST API Get Transaction Report

2019-12-10T14:15:16Z

Offeritnick:

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /report/transaction''' ==
'''Description'''
*Offerit supports an API resource to grab all the stats used within the Offerit transactions report.

'''Resource URL'''
*<nowiki>http://domain/api/report/transaction</nowiki>
*Replace domain with the offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

** '''period''' - Which period of time to select data for. See below for more information regarding the periods within Offerit.
** '''start''' - start date for the stats. Used when period is not sent or set to 8
** '''end''' - end date for the stats. Used when period is not sent or set to 8
** '''filter_affiliate''' - Only see stats for specific affiliate
** '''filter_loginid''' - Only see stats for the specifc login ID passed in.
** '''filter_campaignid''' - Only see stats for the specific campaign ID for the affiliate. (Can only be used if filter_loginid is passed in)
** '''filter_offerid''' - Only see stats for the specific site ID passed in.
** '''filter_landingpageid''' - Only see stats for the specific tour ID passed in.
** '''filter_adtoolid''' - Only see stats for the specific adtool ID passed in.
** '''filter_programid''' - Only see stats for the specific program ID passed in.
** '''filter_countryid''' - Only see stats for the specific Country ID passed in.
** '''no_inhouse''' - 0 for all affiliates, 1 to exclude inhouse.
** '''trans_type''' - Type of transactions to return. Default is all.
** '''filter_external_clickid''' - search for a specific affiliate _ocid.
** '''filter_transaction_hash''' - search for an internal click_hash.
** '''filter_orderid''' - search for a transaction with a specific orderid.
** '''trans_start''' - Number of transactions to offset default 0.
** '''trans_count''' - Number of transactions to return default 100.

== Periods ==
{| class="tmplfunc" border="1"
|-
! # || Name || Argument Description
|-
| 0 || current || Current Period
|-
| 1 || last || Last Period
|-
| 2 || today || Today
|-
| 3 || yesterday || Yesterday
|-
| 4 || week || This Week
|-
| 5 || month || This Month
|-
| 6 || year || This Year
|-
| 7 || all || All Time
|-
| 8 || free || Freeform (See also the ''start'' and ''end'' parameters above)

|}

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = array(
'period' => 2,
);

$data_string = http_build_query($data);
$url = 'http://domain/api/report/transaction?'.$data_string;

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

[[Category:Offerit API Articles]]

Offerit Currency Exchange Rates

2019-07-16T17:47:17Z

Offeritnick: /* Automatic Updates *COMING SOON* */

{{Offerit Manual|show_setup_section=true}}

Ideally, the amounts reported back to Offerit should be a converted amount to your base currency. However, offerit can be used for converting amounts instead. When sending a postback to offerit for a different currency, we will use the exchange rate configured in your Offerit install at the time we receive the postback/pixel call for a transaction. With these details in mind, here are a few potential issues that can occur when using Offerit for converting currencies:
* The exchange rate used by the processor for the transaction does not match up with the exchange rate configured in offerit when the postback/pixel is received
* The exchange rate our source is reporting does not match the rate you want or expect
* The source api fails to return the latest rates

= Automatic Updates *COMING SOON* =
By default Offerit updates conversion rates once a day from https://exchangeratesapi.io/. We have options to decrease this frequency to weekly if you choose. If you would like to update more frequently than this, you can turn OFF the automatic update configuration and use our [[Offerit_REST_API_Set_Currency_Exchange_Rates|Set Currency Exchange Rates API]] to send exchange rate updates.

== Automatic Update Configurations ==
* Automatic Exchange Rate Updates - Turn automatic updates for currency exchange rates on or off.
* Automatic Update Currency List - You can use a comma separated list if you only want to opt-in to automatic updates for specific currencies.
* Automatic Update Exclude Currency List - You can use a comma separated list if you want to opt-out of automatic updates for specific currencies.
* Automatic Update Schedule - Daily is our default, but you can choose weekly updates on a specific day of the week as well.
* Exchange Rate Source - The source API you would like to receive automatic updates from.
* Open Exchange Rates App ID - If you choose "Open Exchange Rates" as your Exchange Rate Soruce, you can use this to set a personal "App ID" for making the API calls to their system.

Offerit Currency Exchange Rates

2019-07-16T17:46:30Z

Offeritnick:

{{Offerit Manual|show_setup_section=true}}

Ideally, the amounts reported back to Offerit should be a converted amount to your base currency. However, offerit can be used for converting amounts instead. When sending a postback to offerit for a different currency, we will use the exchange rate configured in your Offerit install at the time we receive the postback/pixel call for a transaction. With these details in mind, here are a few potential issues that can occur when using Offerit for converting currencies:
* The exchange rate used by the processor for the transaction does not match up with the exchange rate configured in offerit when the postback/pixel is received
* The exchange rate our source is reporting does not match the rate you want or expect
* The source api fails to return the latest rates

= Automatic Updates *COMING SOON* =
By default Offerit updates conversion rates once a day from https://exchangeratesapi.io/. We have options to decrease this frequency to weekly if you choose. If you would like to update more frequently than this, you can turn OFF the automatic update configuration and use our API to send exchange rate updates.
[[Offerit_REST_API_Set_Currency_Exchange_Rates|Set Currency Exchange Rates API]]

== Automatic Update Configurations ==
* Automatic Exchange Rate Updates - Turn automatic updates for currency exchange rates on or off.
* Automatic Update Currency List - You can use a comma separated list if you only want to opt-in to automatic updates for specific currencies.
* Automatic Update Exclude Currency List - You can use a comma separated list if you want to opt-out of automatic updates for specific currencies.
* Automatic Update Schedule - Daily is our default, but you can choose weekly updates on a specific day of the week as well.
* Exchange Rate Source - The source API you would like to receive automatic updates from.
* Open Exchange Rates App ID - If you choose "Open Exchange Rates" as your Exchange Rate Soruce, you can use this to set a personal "App ID" for making the API calls to their system.

Template:Offerit Manual

2019-07-16T17:31:36Z

Offeritnick:

{| class="offeritnavbox"
! [[Offerit|Offerit]]
{| class="mw-collapsible {{{show_for_affiliates_section|mw-collapsed}}}" width="100%"
! class="i1" | For Affiliates
|-
| [[Automatic SubIDs]]
|-
| [[Affiliate Stats Dumps|Affiliate Stats Dumps]]
|-
| [[Linkcode|Linkcode]]
|-
| [[Link Groups|Link Groups]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Host and Post]]

|}
{| class="mw-collapsible {{{show_affiliate_area_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Affiliate Area
|-

| [[Affiliate Account Details]]
|-
| [[Affiliate Account Change Log]]
|-
| [[Offerit Affiliate Creatives|Affiliate Creatives]]
|-
| [[Affiliate Creatives Search]]
|-
| [[Affiliate Settings]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Linkcodes]]
|-
| [[Affiliate Linkcode Settings]]
|-
| [[Affiliate Login History]]
|-
| [[Affiliate Messages]]
|-
| [[Affiliate Dashboard]]
|-
| [[Affiliate Dashboard Key Statistics|Dashboard Key Statistics]]
|-
| [[Affiliate Dashboard Statistics Summary|Dashboard Statistics Summary]]
|-
| [[Affiliate Payment History]]
|-
| [[Quick Links]]
|-
| [[Affiliate Referrals Report]]
|-
| [[Affiliate Referring URL Report]]
|-
| [[Affiliate Remote Login]]
|-
| [[Affiliate Signup]]
|-
| [[Affiliate Statistic Filters]]
|-
| [[Affiliate Statistic Views]]
|-
| [[Affiliate SubIDs]]



|}
{| class="mw-collapsible {{{show_setup_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Setup

|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[Tracking Domain]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]
|-
| [[Getting Started Admin]]
|-
| [[Offerit Quick-Start Guide]]
|-
| [[Tracking in Offerit]]
|-
| [[Pixel Builder]]
|-
| [[Offerit Postback Examples]]
|-
| [[Replacement Variables]]
|-
| [[Offerit Currency Exchange Rates|Currency Exchange Rates]]
|}
<hr />
{| class="mw-collapsible {{{show_admin_overview_section|mw-collapsed}}}" width="100%"
! class="i1" | Admin Dashboard
|-
| [[Admin Dashboard|The Admin Dashboard]]
|}
{| class="mw-collapsible {{{show_reporting_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Reporting Admin
|-
| [[Reporting Admin|The Reporting Admin]]
|-
| [[Track and Strack|Track and Strack]]
|-

|}
{| class="mw-collapsible {{{show_report_breakdowns_section|mw-collapsed}}}" width="100%"
! class="i1" |   Report Breakdowns
|-
| [[Profit and Loss Report|Profit and Loss Report]]
|-
| [[Subscription Report|Subscription Report]]
|-
| [[Transactions Report|Transactions Reports]]

|-
| [[Affiliate Ratios Report|Affiliate Ratios Report]]
|-
| [[Affiliate Managers Report]]
|-
| [[Surfer Actions Report|Visitor Actions Report]]
|-
| [[Affiliate Referral Tier Commissions Report|Referral Tier Payouts Report]]
|-
| [[Affiliate Referral Signup Commissions Report|Referral Signup Payouts Report]]
|-
| [[Additional Commissions Report|Additional Commissions Report]]
|-
| [[Graphical Affiliate Comparison Report|Graphical Affiliate Comparison Report]]
|-
| [[Single Day Comparison Report|The Single Day Comparison Report]]
|-
| [[Actual Affiliate Payments|Actual Affiliate Payments Report]]

|}
{| class="mw-collapsible {{{show_offers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Offers Admin
|-
| [[Offers Admin|The Offers Admin]]
|-
| [[Offers|Offers]]
|-
| [[Offer Setup]]
|-
| [[Affiliate Referrals]]
|-
| [[Tracking Domain]]
|-
| [[Offerit Commission|Commissions]]
|-
| [[Commission Changes]]
|-
| [[Suppression Lists]]
|-
| [[Pixel Builder]]

|-
| [[ID Numbers]]
|-
| [[Offer Partner]]

|-
| [[Offer/Landing Page Redirection]]
|-
| [[Offerit Rules|Setting Rules]]
|-
| [[Admin Host and Post]]
|-
| [[Offer Post URLs]]
|-
| [[Offer Goals]]
|}
{| class="mw-collapsible {{{show_affiliates_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Affiliates Admin
|-
| [[Affiliates Admin|The Affiliates Admin]]
|-
| [[ID Numbers]]
|-
| [[Affiliate Managers]]
|-
| [[Affiliate Referrals]]
|-
| [[Offerit Affiliate Activation|Affiliate Activation]]
|-
| [[Admin-Only Settings]]
|-
| [[Offerit Affiliate Override|Affiliate Overrides]]
|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[In House Accounts|In-House Accounts]]
|-
| [[Add Manual Sale]]
|-
| [[Offerit Manual Invoice|Manual Invoice]]
|-
| [[Offerit Affiliate Documents|Affiliate Documents]]
|-
| [[Affiliate Enabled Offers]]
|-
| [[Change Affiliate Status]]
|-
| [[Account Changes]]
|-
|}
{| class="mw-collapsible {{{show_advertisers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Advertisers Admin
|-
| [[Advertisers Admin|The Advertisers Admin]]
|-
| [[Account Changes]]
|-
| [[Advertiser Invoices]]
|-
| [[Generate Invoice]]
|-
| [[Advertiser Approval]]
|-
| [[Change Advertiser Status]]
|}
{| class="mw-collapsible {{{show_customers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Customers Admin
|-
| [[Customers Admin]]
|-
| [[Offerit Add Customer|Manually Adding a Customer]]
|-
| [[ID Numbers]]
|-
|}

{| class="mw-collapsible {{{show_payments_admin_section|mw-collapsed}}}" width="100%"
! class="i1" |Payments Admin
|-
| [[Payments Admin|The Payments Admin]]
|-
| [[Payvia Types]]
|-
| [[Payout Periods]]
|-
| [[Payvia Dump Formats]]
|-
| [[Payment Dump Entry Numbers |Payment Dump Entry Numbers]]
|-
| [[Offerit Payment Dump Variables|Payment Dump Variables]]
|-
| [[Offerit Check Functions|Check Functions]]
|-
| [[Offerit Rules|Setting Rules]]
|}
{| class="mw-collapsible {{{show_payment_methods_section|mw-collapsed}}}" width="100%"
! class="i1" |Payment Methods
|-
| [[Payza|Payza]]
|}
{| class="mw-collapsible {{{show_creatives_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Creatives Admin
|-
| [[Creatives Admin|The Creatives Admin]]

|-
| [[Offerit Add New Creatives|Add New Creatives]]
|-
| [[Offerit Add New Creative Type|Add New Creative Type]]
|-
| [[Offeritcode]]

|-
| [[Code Builder]]
|-
| [[Track and Strack]]
|-
| [[Offerit Rules|Setting Rules]]
|-
|}
{| class="mw-collapsible {{{show_creative_types_section|mw-collapsed}}}" width="100%"
! class="i1" |   Default Creative Types
|-
| [[Creative Types]]
|-
| [[Offerit Image Banners|Image Banners]]
|-
| [[Offerit Flash Banners|Flash Banners]]
|-
| [[Offerit Dynamic Text Banners|Dynamic Text Banners]]
|-
| [[Offerit Feeds|Feeds]]
|-
| [[Offerit Mailers|Mailers]]
|-
| [[Offerit Downloadable Videos|Video Download]]
|-
| [[Offerit Embedded Videos|Video Embed]]
|-
| [[Offerit Page Peels|Page Peels]]
|-
| [[Offerit IM Popups|IM Popups]]
|-
| [[Offerit Footer Ads|Footer Ads]]
|-
| [[Offerit Page Ads|Page Ads]]
|-
| [[Offerit Overlays|Overlays]]
|-
|}

{| class="mw-collapsible {{{show_communications_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Communications Admin
|-
| [[Communications Admin|The Communications Admin]]
|-
| [[Offerit Add News|Add News Item]]
|-
| [[Offerit Send Message|Sending Messages]]
|-
| [[Signup Questions]]

|}
{| class="mw-collapsible {{{show_configuration_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Configuration Admin
|-
| [[Configuration Admin|The Configuration Admin]]

|-
| [[Offerit Affiliate Signup Postback URL|Affiliate Signup Postback URL]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]

|}

{| class="mw-collapsible {{{show_rest_api_section|mw-collapsed}}}" width="100%"
! class="i1" | REST API
|-
! class="i1" | General
|-
| [[Offerit REST API Overview]]
|-
| [[Offerit REST API Ping|GET /service/ping]]
|-
| [[Offerit REST API Set Currency Exchange Rates|PATCH /service/set_currency_exchange_rates]]
|-
! class="i1" | Advertiser
|-
| [[Offerit REST API Edit Advertiser |PATCH /advertiser/edit_advertiser]]
|-
| [[Offerit REST API Add Advertiser |POST /advertiser/add_advertiser]]
|-
! class="i1" | Affiliate
|-
| [[Offerit REST API Get Links |GET /affiliate/get_links]]
|-
| [[Offerit REST API Get Single Link |GET /affiliate/get_single_link]]
|-
| [[Offerit REST API Search_Affiliate|GET /affiliate/search]]
|-
| [[Offerit REST API Decode Trackingcode|GET /affiliate/decode_trackingcode]]
|-
| [[Offerit REST API Edit Affiliate |PATCH /affiliate/edit_affiliate]]
|-
| [[Offerit REST API Set Affiliate Payvia Info|PATCH /affiliate/payvia]]
|-
| [[Offerit REST API Add Affiliate|POST /affiliate/add_affiliate]]
|-
| [[Offerit REST API Affiliate Login Ips|POST /affiliate/affiliate_login_ips]]
|-
! class="i1" | Creative
|-
| [[Offerit REST API Get Creatives |GET /creative/get_creatives]]
|-
| [[Offerit REST API Get Creatives Fields|GET /creative/get_creative_fields]]
|-
| [[Offerit REST API Get Creatives Rules|GET /creative/get_creative_rules]]
|-
| [[Offerit REST API Delete Creative|PATCH /creative/delete_creative]]
|-
| [[Offerit REST API Edit Creative|PATCH /creative/edit_creative]]
|-
| [[Offerit REST API Edit Creative Rules|PATCH /creative/edit_creative_rules]]
|-
| [[Offerit REST API Undelete Creative|PATCH /creative/undelete_creative]]
|-
| [[Offerit REST API Add Creative|POST /creative/add_creative]]
|-
| [[Offerit REST API Add Creative Rule|POST /creative/add_creative_rule]]
|-
| [[Offerit REST API Delete Creative Rules|POST /creative/delete_creative_rules]]
|-
! class="i1" | Customer
|-
| [[Offerit REST API Set Customer Details|PATCH /customer/set_customer_details]]
|-
| [[Offerit REST API Lock Customer|PATCH /customer/lock]]
|-
| [[Offerit REST API Unlock Customer|PATCH /customer/unlock]]
|-
| [[Offerit REST API Forget Customer|PATCH /customer/forget]]
|-
| [[Offerit REST API Export Customer|GET /customer/export]]
|-
! class="i1" | Offer
|-
| [[Offerit REST API Get Conversion Caps|GET /offer/get_conversion_caps]]
|-
| [[Offerit REST API Check Orderid Exists|GET /offer/check_orderid_exists]]
|-
| [[Offerit REST API Get Commission Changes|GET /offer/get_commission_changes]]
|-
| [[Offerit REST API Activate Offer|PATCH /offer/activate_offer]]
|-
| [[Offerit REST API Edit Landing Page |PATCH /offer/edit_landing_page]]
|-
| [[Offerit REST API Edit Offer |PATCH /offer/edit_offer]]
|-
| [[Offerit REST API Pause Offer|PATCH /offer/pause_offer]]
|-
| [[Offerit REST API Set Commission Change Payouts|PATCH /offer/set_commission_change_payouts]]
|-
| [[Offerit REST API Set Enabled Affiliates |PATCH /offer/set_enabled_affiliates]]
|-
| [[Offerit REST API Set Offer Categories|PATCH /offer/set_offer_categories]]
|-
| [[Offerit REST API Set Offer Countries|PATCH /offer/set_offer_countries]]
|-
| [[Offerit REST API Set Offer Goals |PATCH /offer/set_offer_goals]]
|-
| [[Offerit REST API Set Offer Groups |PATCH /offer/set_offer_groups]]
|-
| [[Offerit REST API Set Offer Marketing Types|PATCH /offer/set_offer_marketing_types]]
|-
| [[Offerit REST API Store Offer Ips|PATCH /offer/store_offer_ips]]
|-
| [[Offerit REST API Add Commission Change |POST /offer/add_commission_change]]
|-
| [[Offerit REST API Add Landing Page |POST /offer/add_landing_page]]
|-
| [[Offerit REST API Add Offer |POST /offer/add_offer]]
|-
| [[Offerit REST API Add Tracking Domain |POST /offer/add_tracking_domain]]
|-
! class="i1" | Reporting
|-
| [[Offerit REST API Get Profit Loss Report|GET /report/profitloss]]
|-
| [[Offerit REST API Get Transaction Report|GET /report/transaction]]
|-
! class="i1" | Transaction
|-
| [[Offerit REST API Get Transaction Payout Preview|GET /transaction/transaction_payout_preview]]
|-
| [[Offerit REST API Transaction Update Revenue By Orderid |PATCH /transaction/transaction_update_revenue_by_orderid]]
|-
| [[Offerit REST API Transaction Update Revenue By Transaction Hash |PATCH /transaction/transaction_update_revenue_by_transaction_hash]]
|-
| [[Offerit REST API Process Void |POST /transaction/process_void]]
|-
| [[Offerit REST API Process Chargeback |POST /transaction/process_chargeback]]
|-
| [[Offerit REST API Process Reversal |POST /transaction/process_reversal]]
|-
| [[Offerit REST API Approve Pending Transaction |POST /transaction/approve_pending_transaction]]
|-
| [[Offerit REST API Click Detail |GET /transaction/click_detail]]
|}
{| class="mw-collapsible {{{show_api_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | SOAP API (*deprecated*)
|-
| [[Offerit API|API]]
|-
| [[Offerit API Add Affiliate|Add Affiliate]]
|-
| [[Offerit API Add Affiliate Sale|Add Affiliate Sale]]
|-
| [[Offerit API Add Offer|Add Offer]]
|-
| [[Offerit API Approve Transaction|Approve Transaction]]

|-
| [[Offerit API Creative Types|Creative Types]]
|-
| [[Offerit API Decode Offeritcode|Decode Offeritcode]]
|-
| [[Offerit API Deny Transaction|Deny Transaction]]
|-
| [[Offerit API Disable Affiliate Landing Page|Disable Affiliate Landing Page]]
|-
| [[Offerit API Edit Affiliate Sale|Edit Affiliate Sale]]
|-
| [[Offerit API Enable Affiliate Landing Page|Enable Affiliate Landing Page]]

|-
| [[Offerit API Get Affiliate Stats|Get Affiliate Stats]]
|-
| [[Offerit API Get Allowed Affiliates|Get Allowed Affiliates]]
|-
| [[Offerit API Get Landing Page Details|Get Landing Page Details]]
|-
| [[Offerit API Get Offer Details|Get Offer Details]]
|-
| [[Offerit API Get Offer List|Get Offer List]]
|-
| [[Offerit API Get Profit Loss Report|Get Profit Loss Report]]

|-
| [[Offerit API List Affiliate Details|List Affiliate Details]]
|-
| [[Offerit API List Affiliate Subaffiliates|List Affiliate Subaffiliates]]
|-
| [[Offerit API Ping|Ping]]
|-

|-
| [[Offerit API Set Affiliate Status|Set Affiliate Status]]

|-
| [[Offerit API Set Subaffiliate Status|Set SubAffiliate Status]]

|-
| [[Offerit API Set Member Details|Set Member Details]]
|-
| [[Offerit API Record Affiliate Click|Record Affiliate Click]]
|}
{| class="mw-collapsible {{{show_misc_section|mw-collapsed}}}" width="100%"
! class="i1" | Misc.
|-
| [[Offerit Rules|Rules]]
|-
| [[Offerit Freeform Date|Freeform Date]]
|-

| [[Affiliate Custom Signup]]
|-
| [[Offeritcode]]
|-
| [[Tracking in Offerit]]
|-
| [[Offerit Logos]]
|-
| [[Void Conversions Remotely]]
|-
|}
<hr />


|}<includeonly>[[Category:Offerit]]</includeonly>

Template:Offerit Manual

2019-07-16T17:31:14Z

Offeritnick:

{| class="offeritnavbox"
! [[Offerit|Offerit]]
{| class="mw-collapsible {{{show_for_affiliates_section|mw-collapsed}}}" width="100%"
! class="i1" | For Affiliates
|-
| [[Automatic SubIDs]]
|-
| [[Affiliate Stats Dumps|Affiliate Stats Dumps]]
|-
| [[Linkcode|Linkcode]]
|-
| [[Link Groups|Link Groups]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Host and Post]]

|}
{| class="mw-collapsible {{{show_affiliate_area_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Affiliate Area
|-

| [[Affiliate Account Details]]
|-
| [[Affiliate Account Change Log]]
|-
| [[Offerit Affiliate Creatives|Affiliate Creatives]]
|-
| [[Affiliate Creatives Search]]
|-
| [[Affiliate Settings]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Linkcodes]]
|-
| [[Affiliate Linkcode Settings]]
|-
| [[Affiliate Login History]]
|-
| [[Affiliate Messages]]
|-
| [[Affiliate Dashboard]]
|-
| [[Affiliate Dashboard Key Statistics|Dashboard Key Statistics]]
|-
| [[Affiliate Dashboard Statistics Summary|Dashboard Statistics Summary]]
|-
| [[Affiliate Payment History]]
|-
| [[Quick Links]]
|-
| [[Affiliate Referrals Report]]
|-
| [[Affiliate Referring URL Report]]
|-
| [[Affiliate Remote Login]]
|-
| [[Affiliate Signup]]
|-
| [[Affiliate Statistic Filters]]
|-
| [[Affiliate Statistic Views]]
|-
| [[Affiliate SubIDs]]



|}
{| class="mw-collapsible {{{show_setup_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Setup

|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[Tracking Domain]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]
|-
| [[Getting Started Admin]]
|-
| [[Offerit Quick-Start Guide]]
|-
| [[Tracking in Offerit]]
|-
| [[Pixel Builder]]
|-
| [[Offerit Postback Examples]]
|-
| [[Replacement Variables]]
|-
| [[Offerit Currency Exchange Rates|Currency Exchange Rates]]
|}
<hr />
{| class="mw-collapsible {{{show_admin_overview_section|mw-collapsed}}}" width="100%"
! class="i1" | Admin Dashboard
|-
| [[Admin Dashboard|The Admin Dashboard]]
|}
{| class="mw-collapsible {{{show_reporting_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Reporting Admin
|-
| [[Reporting Admin|The Reporting Admin]]
|-
| [[Track and Strack|Track and Strack]]
|-

|}
{| class="mw-collapsible {{{show_report_breakdowns_section|mw-collapsed}}}" width="100%"
! class="i1" |   Report Breakdowns
|-
| [[Profit and Loss Report|Profit and Loss Report]]
|-
| [[Subscription Report|Subscription Report]]
|-
| [[Transactions Report|Transactions Reports]]

|-
| [[Affiliate Ratios Report|Affiliate Ratios Report]]
|-
| [[Affiliate Managers Report]]
|-
| [[Surfer Actions Report|Visitor Actions Report]]
|-
| [[Affiliate Referral Tier Commissions Report|Referral Tier Payouts Report]]
|-
| [[Affiliate Referral Signup Commissions Report|Referral Signup Payouts Report]]
|-
| [[Additional Commissions Report|Additional Commissions Report]]
|-
| [[Graphical Affiliate Comparison Report|Graphical Affiliate Comparison Report]]
|-
| [[Single Day Comparison Report|The Single Day Comparison Report]]
|-
| [[Actual Affiliate Payments|Actual Affiliate Payments Report]]

|}
{| class="mw-collapsible {{{show_offers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Offers Admin
|-
| [[Offers Admin|The Offers Admin]]
|-
| [[Offers|Offers]]
|-
| [[Offer Setup]]
|-
| [[Affiliate Referrals]]
|-
| [[Tracking Domain]]
|-
| [[Offerit Commission|Commissions]]
|-
| [[Commission Changes]]
|-
| [[Suppression Lists]]
|-
| [[Pixel Builder]]

|-
| [[ID Numbers]]
|-
| [[Offer Partner]]

|-
| [[Offer/Landing Page Redirection]]
|-
| [[Offerit Rules|Setting Rules]]
|-
| [[Admin Host and Post]]
|-
| [[Offer Post URLs]]
|-
| [[Offer Goals]]
|}
{| class="mw-collapsible {{{show_affiliates_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Affiliates Admin
|-
| [[Affiliates Admin|The Affiliates Admin]]
|-
| [[ID Numbers]]
|-
| [[Affiliate Managers]]
|-
| [[Affiliate Referrals]]
|-
| [[Offerit Affiliate Activation|Affiliate Activation]]
|-
| [[Admin-Only Settings]]
|-
| [[Offerit Affiliate Override|Affiliate Overrides]]
|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[In House Accounts|In-House Accounts]]
|-
| [[Add Manual Sale]]
|-
| [[Offerit Manual Invoice|Manual Invoice]]
|-
| [[Offerit Affiliate Documents|Affiliate Documents]]
|-
| [[Affiliate Enabled Offers]]
|-
| [[Change Affiliate Status]]
|-
| [[Account Changes]]
|-
|}
{| class="mw-collapsible {{{show_advertisers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Advertisers Admin
|-
| [[Advertisers Admin|The Advertisers Admin]]
|-
| [[Account Changes]]
|-
| [[Advertiser Invoices]]
|-
| [[Generate Invoice]]
|-
| [[Advertiser Approval]]
|-
| [[Change Advertiser Status]]
|}
{| class="mw-collapsible {{{show_customers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Customers Admin
|-
| [[Customers Admin]]
|-
| [[Offerit Add Customer|Manually Adding a Customer]]
|-
| [[ID Numbers]]
|-
|}

{| class="mw-collapsible {{{show_payments_admin_section|mw-collapsed}}}" width="100%"
! class="i1" |Payments Admin
|-
| [[Payments Admin|The Payments Admin]]
|-
| [[Payvia Types]]
|-
| [[Payout Periods]]
|-
| [[Payvia Dump Formats]]
|-
| [[Payment Dump Entry Numbers |Payment Dump Entry Numbers]]
|-
| [[Offerit Payment Dump Variables|Payment Dump Variables]]
|-
| [[Offerit Check Functions|Check Functions]]
|-
| [[Offerit Rules|Setting Rules]]
|}
{| class="mw-collapsible {{{show_payment_methods_section|mw-collapsed}}}" width="100%"
! class="i1" |Payment Methods
|-
| [[Payza|Payza]]
|}
{| class="mw-collapsible {{{show_creatives_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Creatives Admin
|-
| [[Creatives Admin|The Creatives Admin]]

|-
| [[Offerit Add New Creatives|Add New Creatives]]
|-
| [[Offerit Add New Creative Type|Add New Creative Type]]
|-
| [[Offeritcode]]

|-
| [[Code Builder]]
|-
| [[Track and Strack]]
|-
| [[Offerit Rules|Setting Rules]]
|-
|}
{| class="mw-collapsible {{{show_creative_types_section|mw-collapsed}}}" width="100%"
! class="i1" |   Default Creative Types
|-
| [[Creative Types]]
|-
| [[Offerit Image Banners|Image Banners]]
|-
| [[Offerit Flash Banners|Flash Banners]]
|-
| [[Offerit Dynamic Text Banners|Dynamic Text Banners]]
|-
| [[Offerit Feeds|Feeds]]
|-
| [[Offerit Mailers|Mailers]]
|-
| [[Offerit Downloadable Videos|Video Download]]
|-
| [[Offerit Embedded Videos|Video Embed]]
|-
| [[Offerit Page Peels|Page Peels]]
|-
| [[Offerit IM Popups|IM Popups]]
|-
| [[Offerit Footer Ads|Footer Ads]]
|-
| [[Offerit Page Ads|Page Ads]]
|-
| [[Offerit Overlays|Overlays]]
|-
|}

{| class="mw-collapsible {{{show_communications_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Communications Admin
|-
| [[Communications Admin|The Communications Admin]]
|-
| [[Offerit Add News|Add News Item]]
|-
| [[Offerit Send Message|Sending Messages]]
|-
| [[Signup Questions]]

|}
{| class="mw-collapsible {{{show_configuration_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Configuration Admin
|-
| [[Configuration Admin|The Configuration Admin]]

|-
| [[Offerit Affiliate Signup Postback URL|Affiliate Signup Postback URL]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]

|}

{| class="mw-collapsible {{{show_rest_api_section|mw-collapsed}}}" width="100%"
! class="i1" | REST API
|-
! class="i1" | General
|-
| [[Offerit REST API Overview]]
|-
| [[Offerit REST API Ping|GET /service/ping]]
|-
| [[Offerit REST API Set Currency Exchange Rates|PATCH /service/ping]]
|-
! class="i1" | Advertiser
|-
| [[Offerit REST API Edit Advertiser |PATCH /advertiser/edit_advertiser]]
|-
| [[Offerit REST API Add Advertiser |POST /advertiser/add_advertiser]]
|-
! class="i1" | Affiliate
|-
| [[Offerit REST API Get Links |GET /affiliate/get_links]]
|-
| [[Offerit REST API Get Single Link |GET /affiliate/get_single_link]]
|-
| [[Offerit REST API Search_Affiliate|GET /affiliate/search]]
|-
| [[Offerit REST API Decode Trackingcode|GET /affiliate/decode_trackingcode]]
|-
| [[Offerit REST API Edit Affiliate |PATCH /affiliate/edit_affiliate]]
|-
| [[Offerit REST API Set Affiliate Payvia Info|PATCH /affiliate/payvia]]
|-
| [[Offerit REST API Add Affiliate|POST /affiliate/add_affiliate]]
|-
| [[Offerit REST API Affiliate Login Ips|POST /affiliate/affiliate_login_ips]]
|-
! class="i1" | Creative
|-
| [[Offerit REST API Get Creatives |GET /creative/get_creatives]]
|-
| [[Offerit REST API Get Creatives Fields|GET /creative/get_creative_fields]]
|-
| [[Offerit REST API Get Creatives Rules|GET /creative/get_creative_rules]]
|-
| [[Offerit REST API Delete Creative|PATCH /creative/delete_creative]]
|-
| [[Offerit REST API Edit Creative|PATCH /creative/edit_creative]]
|-
| [[Offerit REST API Edit Creative Rules|PATCH /creative/edit_creative_rules]]
|-
| [[Offerit REST API Undelete Creative|PATCH /creative/undelete_creative]]
|-
| [[Offerit REST API Add Creative|POST /creative/add_creative]]
|-
| [[Offerit REST API Add Creative Rule|POST /creative/add_creative_rule]]
|-
| [[Offerit REST API Delete Creative Rules|POST /creative/delete_creative_rules]]
|-
! class="i1" | Customer
|-
| [[Offerit REST API Set Customer Details|PATCH /customer/set_customer_details]]
|-
| [[Offerit REST API Lock Customer|PATCH /customer/lock]]
|-
| [[Offerit REST API Unlock Customer|PATCH /customer/unlock]]
|-
| [[Offerit REST API Forget Customer|PATCH /customer/forget]]
|-
| [[Offerit REST API Export Customer|GET /customer/export]]
|-
! class="i1" | Offer
|-
| [[Offerit REST API Get Conversion Caps|GET /offer/get_conversion_caps]]
|-
| [[Offerit REST API Check Orderid Exists|GET /offer/check_orderid_exists]]
|-
| [[Offerit REST API Get Commission Changes|GET /offer/get_commission_changes]]
|-
| [[Offerit REST API Activate Offer|PATCH /offer/activate_offer]]
|-
| [[Offerit REST API Edit Landing Page |PATCH /offer/edit_landing_page]]
|-
| [[Offerit REST API Edit Offer |PATCH /offer/edit_offer]]
|-
| [[Offerit REST API Pause Offer|PATCH /offer/pause_offer]]
|-
| [[Offerit REST API Set Commission Change Payouts|PATCH /offer/set_commission_change_payouts]]
|-
| [[Offerit REST API Set Enabled Affiliates |PATCH /offer/set_enabled_affiliates]]
|-
| [[Offerit REST API Set Offer Categories|PATCH /offer/set_offer_categories]]
|-
| [[Offerit REST API Set Offer Countries|PATCH /offer/set_offer_countries]]
|-
| [[Offerit REST API Set Offer Goals |PATCH /offer/set_offer_goals]]
|-
| [[Offerit REST API Set Offer Groups |PATCH /offer/set_offer_groups]]
|-
| [[Offerit REST API Set Offer Marketing Types|PATCH /offer/set_offer_marketing_types]]
|-
| [[Offerit REST API Store Offer Ips|PATCH /offer/store_offer_ips]]
|-
| [[Offerit REST API Add Commission Change |POST /offer/add_commission_change]]
|-
| [[Offerit REST API Add Landing Page |POST /offer/add_landing_page]]
|-
| [[Offerit REST API Add Offer |POST /offer/add_offer]]
|-
| [[Offerit REST API Add Tracking Domain |POST /offer/add_tracking_domain]]
|-
! class="i1" | Reporting
|-
| [[Offerit REST API Get Profit Loss Report|GET /report/profitloss]]
|-
| [[Offerit REST API Get Transaction Report|GET /report/transaction]]
|-
! class="i1" | Transaction
|-
| [[Offerit REST API Get Transaction Payout Preview|GET /transaction/transaction_payout_preview]]
|-
| [[Offerit REST API Transaction Update Revenue By Orderid |PATCH /transaction/transaction_update_revenue_by_orderid]]
|-
| [[Offerit REST API Transaction Update Revenue By Transaction Hash |PATCH /transaction/transaction_update_revenue_by_transaction_hash]]
|-
| [[Offerit REST API Process Void |POST /transaction/process_void]]
|-
| [[Offerit REST API Process Chargeback |POST /transaction/process_chargeback]]
|-
| [[Offerit REST API Process Reversal |POST /transaction/process_reversal]]
|-
| [[Offerit REST API Approve Pending Transaction |POST /transaction/approve_pending_transaction]]
|-
| [[Offerit REST API Click Detail |GET /transaction/click_detail]]
|}
{| class="mw-collapsible {{{show_api_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | SOAP API (*deprecated*)
|-
| [[Offerit API|API]]
|-
| [[Offerit API Add Affiliate|Add Affiliate]]
|-
| [[Offerit API Add Affiliate Sale|Add Affiliate Sale]]
|-
| [[Offerit API Add Offer|Add Offer]]
|-
| [[Offerit API Approve Transaction|Approve Transaction]]

|-
| [[Offerit API Creative Types|Creative Types]]
|-
| [[Offerit API Decode Offeritcode|Decode Offeritcode]]
|-
| [[Offerit API Deny Transaction|Deny Transaction]]
|-
| [[Offerit API Disable Affiliate Landing Page|Disable Affiliate Landing Page]]
|-
| [[Offerit API Edit Affiliate Sale|Edit Affiliate Sale]]
|-
| [[Offerit API Enable Affiliate Landing Page|Enable Affiliate Landing Page]]

|-
| [[Offerit API Get Affiliate Stats|Get Affiliate Stats]]
|-
| [[Offerit API Get Allowed Affiliates|Get Allowed Affiliates]]
|-
| [[Offerit API Get Landing Page Details|Get Landing Page Details]]
|-
| [[Offerit API Get Offer Details|Get Offer Details]]
|-
| [[Offerit API Get Offer List|Get Offer List]]
|-
| [[Offerit API Get Profit Loss Report|Get Profit Loss Report]]

|-
| [[Offerit API List Affiliate Details|List Affiliate Details]]
|-
| [[Offerit API List Affiliate Subaffiliates|List Affiliate Subaffiliates]]
|-
| [[Offerit API Ping|Ping]]
|-

|-
| [[Offerit API Set Affiliate Status|Set Affiliate Status]]

|-
| [[Offerit API Set Subaffiliate Status|Set SubAffiliate Status]]

|-
| [[Offerit API Set Member Details|Set Member Details]]
|-
| [[Offerit API Record Affiliate Click|Record Affiliate Click]]
|}
{| class="mw-collapsible {{{show_misc_section|mw-collapsed}}}" width="100%"
! class="i1" | Misc.
|-
| [[Offerit Rules|Rules]]
|-
| [[Offerit Freeform Date|Freeform Date]]
|-

| [[Affiliate Custom Signup]]
|-
| [[Offeritcode]]
|-
| [[Tracking in Offerit]]
|-
| [[Offerit Logos]]
|-
| [[Void Conversions Remotely]]
|-
|}
<hr />


|}<includeonly>[[Category:Offerit]]</includeonly>

Offerit REST API Set Currency Exchange Rates

2019-07-16T17:30:00Z

Offeritnick:

{{Offerit Manual
| show_rest_api_section = true
}}
* COMING SOON *
== '''PATCH /service/set_currency_exchange_rates''' ==

'''Description'''
* Sets currency exchange rates in your configuration. For example, in the Configuration Admin, "Currency - All" section, you can update the value for a rate such as "EUR Exchange Rate to USD".

'''Resource URL'''
*<nowiki>http://domain/api/service/set_currency_exchange_rates</nowiki>

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*base
**'''''type: string'''''
**'''''required'''
** base currency to set rates for
*rates
**'''''type: array'''''
**'''''required'''
** Array of other currencies with the conversion rate to the "base" parameter above.

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/service/set_currency_exchange_rates';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'base' => 'USD',
'rates' => Array(
'EUR' => 0.8639308856,
'AUD' => 1.4094168468,
'CAD' => 1.3047084234,
),
);

$data_string = http_build_query($data);
$url .= '?'.$data_string;

curl_setopt($curl, CURLOPT_GET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

== '''Example Output''' ==
<pre>
Array
(
[result] => success
[message] => Saved new rates to config. EUR: 0.8639308856; AUD: 1.4094168468; CAD: 1.3047084234;
)
</pre>

Template:Offerit Manual

2019-07-16T17:28:29Z

Offeritnick:

{| class="offeritnavbox"
! [[Offerit|Offerit]]
{| class="mw-collapsible {{{show_for_affiliates_section|mw-collapsed}}}" width="100%"
! class="i1" | For Affiliates
|-
| [[Automatic SubIDs]]
|-
| [[Affiliate Stats Dumps|Affiliate Stats Dumps]]
|-
| [[Linkcode|Linkcode]]
|-
| [[Link Groups|Link Groups]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Host and Post]]

|}
{| class="mw-collapsible {{{show_affiliate_area_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Affiliate Area
|-

| [[Affiliate Account Details]]
|-
| [[Affiliate Account Change Log]]
|-
| [[Offerit Affiliate Creatives|Affiliate Creatives]]
|-
| [[Affiliate Creatives Search]]
|-
| [[Affiliate Settings]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Linkcodes]]
|-
| [[Affiliate Linkcode Settings]]
|-
| [[Affiliate Login History]]
|-
| [[Affiliate Messages]]
|-
| [[Affiliate Dashboard]]
|-
| [[Affiliate Dashboard Key Statistics|Dashboard Key Statistics]]
|-
| [[Affiliate Dashboard Statistics Summary|Dashboard Statistics Summary]]
|-
| [[Affiliate Payment History]]
|-
| [[Quick Links]]
|-
| [[Affiliate Referrals Report]]
|-
| [[Affiliate Referring URL Report]]
|-
| [[Affiliate Remote Login]]
|-
| [[Affiliate Signup]]
|-
| [[Affiliate Statistic Filters]]
|-
| [[Affiliate Statistic Views]]
|-
| [[Affiliate SubIDs]]



|}
{| class="mw-collapsible {{{show_setup_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Setup

|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[Tracking Domain]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]
|-
| [[Getting Started Admin]]
|-
| [[Offerit Quick-Start Guide]]
|-
| [[Tracking in Offerit]]
|-
| [[Pixel Builder]]
|-
| [[Offerit Postback Examples]]
|-
| [[Replacement Variables]]
|-
| [[Offerit Currency Exchange Rates|Currency Exchange Rates]]
|}
<hr />
{| class="mw-collapsible {{{show_admin_overview_section|mw-collapsed}}}" width="100%"
! class="i1" | Admin Dashboard
|-
| [[Admin Dashboard|The Admin Dashboard]]
|}
{| class="mw-collapsible {{{show_reporting_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Reporting Admin
|-
| [[Reporting Admin|The Reporting Admin]]
|-
| [[Track and Strack|Track and Strack]]
|-

|}
{| class="mw-collapsible {{{show_report_breakdowns_section|mw-collapsed}}}" width="100%"
! class="i1" |   Report Breakdowns
|-
| [[Profit and Loss Report|Profit and Loss Report]]
|-
| [[Subscription Report|Subscription Report]]
|-
| [[Transactions Report|Transactions Reports]]

|-
| [[Affiliate Ratios Report|Affiliate Ratios Report]]
|-
| [[Affiliate Managers Report]]
|-
| [[Surfer Actions Report|Visitor Actions Report]]
|-
| [[Affiliate Referral Tier Commissions Report|Referral Tier Payouts Report]]
|-
| [[Affiliate Referral Signup Commissions Report|Referral Signup Payouts Report]]
|-
| [[Additional Commissions Report|Additional Commissions Report]]
|-
| [[Graphical Affiliate Comparison Report|Graphical Affiliate Comparison Report]]
|-
| [[Single Day Comparison Report|The Single Day Comparison Report]]
|-
| [[Actual Affiliate Payments|Actual Affiliate Payments Report]]

|}
{| class="mw-collapsible {{{show_offers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Offers Admin
|-
| [[Offers Admin|The Offers Admin]]
|-
| [[Offers|Offers]]
|-
| [[Offer Setup]]
|-
| [[Affiliate Referrals]]
|-
| [[Tracking Domain]]
|-
| [[Offerit Commission|Commissions]]
|-
| [[Commission Changes]]
|-
| [[Suppression Lists]]
|-
| [[Pixel Builder]]

|-
| [[ID Numbers]]
|-
| [[Offer Partner]]

|-
| [[Offer/Landing Page Redirection]]
|-
| [[Offerit Rules|Setting Rules]]
|-
| [[Admin Host and Post]]
|-
| [[Offer Post URLs]]
|-
| [[Offer Goals]]
|}
{| class="mw-collapsible {{{show_affiliates_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Affiliates Admin
|-
| [[Affiliates Admin|The Affiliates Admin]]
|-
| [[ID Numbers]]
|-
| [[Affiliate Managers]]
|-
| [[Affiliate Referrals]]
|-
| [[Offerit Affiliate Activation|Affiliate Activation]]
|-
| [[Admin-Only Settings]]
|-
| [[Offerit Affiliate Override|Affiliate Overrides]]
|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[In House Accounts|In-House Accounts]]
|-
| [[Add Manual Sale]]
|-
| [[Offerit Manual Invoice|Manual Invoice]]
|-
| [[Offerit Affiliate Documents|Affiliate Documents]]
|-
| [[Affiliate Enabled Offers]]
|-
| [[Change Affiliate Status]]
|-
| [[Account Changes]]
|-
|}
{| class="mw-collapsible {{{show_advertisers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Advertisers Admin
|-
| [[Advertisers Admin|The Advertisers Admin]]
|-
| [[Account Changes]]
|-
| [[Advertiser Invoices]]
|-
| [[Generate Invoice]]
|-
| [[Advertiser Approval]]
|-
| [[Change Advertiser Status]]
|}
{| class="mw-collapsible {{{show_customers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Customers Admin
|-
| [[Customers Admin]]
|-
| [[Offerit Add Customer|Manually Adding a Customer]]
|-
| [[ID Numbers]]
|-
|}

{| class="mw-collapsible {{{show_payments_admin_section|mw-collapsed}}}" width="100%"
! class="i1" |Payments Admin
|-
| [[Payments Admin|The Payments Admin]]
|-
| [[Payvia Types]]
|-
| [[Payout Periods]]
|-
| [[Payvia Dump Formats]]
|-
| [[Payment Dump Entry Numbers |Payment Dump Entry Numbers]]
|-
| [[Offerit Payment Dump Variables|Payment Dump Variables]]
|-
| [[Offerit Check Functions|Check Functions]]
|-
| [[Offerit Rules|Setting Rules]]
|}
{| class="mw-collapsible {{{show_payment_methods_section|mw-collapsed}}}" width="100%"
! class="i1" |Payment Methods
|-
| [[Payza|Payza]]
|}
{| class="mw-collapsible {{{show_creatives_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Creatives Admin
|-
| [[Creatives Admin|The Creatives Admin]]

|-
| [[Offerit Add New Creatives|Add New Creatives]]
|-
| [[Offerit Add New Creative Type|Add New Creative Type]]
|-
| [[Offeritcode]]

|-
| [[Code Builder]]
|-
| [[Track and Strack]]
|-
| [[Offerit Rules|Setting Rules]]
|-
|}
{| class="mw-collapsible {{{show_creative_types_section|mw-collapsed}}}" width="100%"
! class="i1" |   Default Creative Types
|-
| [[Creative Types]]
|-
| [[Offerit Image Banners|Image Banners]]
|-
| [[Offerit Flash Banners|Flash Banners]]
|-
| [[Offerit Dynamic Text Banners|Dynamic Text Banners]]
|-
| [[Offerit Feeds|Feeds]]
|-
| [[Offerit Mailers|Mailers]]
|-
| [[Offerit Downloadable Videos|Video Download]]
|-
| [[Offerit Embedded Videos|Video Embed]]
|-
| [[Offerit Page Peels|Page Peels]]
|-
| [[Offerit IM Popups|IM Popups]]
|-
| [[Offerit Footer Ads|Footer Ads]]
|-
| [[Offerit Page Ads|Page Ads]]
|-
| [[Offerit Overlays|Overlays]]
|-
|}

{| class="mw-collapsible {{{show_communications_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Communications Admin
|-
| [[Communications Admin|The Communications Admin]]
|-
| [[Offerit Add News|Add News Item]]
|-
| [[Offerit Send Message|Sending Messages]]
|-
| [[Signup Questions]]

|}
{| class="mw-collapsible {{{show_configuration_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Configuration Admin
|-
| [[Configuration Admin|The Configuration Admin]]

|-
| [[Offerit Affiliate Signup Postback URL|Affiliate Signup Postback URL]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]

|}

{| class="mw-collapsible {{{show_rest_api_section|mw-collapsed}}}" width="100%"
! class="i1" | REST API
|-
! class="i1" | General
|-
| [[Offerit REST API Overview]]
|-
| [[Offerit REST API Ping|GET /service/ping]]
|-
! class="i1" | Advertiser
|-
| [[Offerit REST API Edit Advertiser |PATCH /advertiser/edit_advertiser]]
|-
| [[Offerit REST API Add Advertiser |POST /advertiser/add_advertiser]]
|-
! class="i1" | Affiliate
|-
| [[Offerit REST API Get Links |GET /affiliate/get_links]]
|-
| [[Offerit REST API Get Single Link |GET /affiliate/get_single_link]]
|-
| [[Offerit REST API Search_Affiliate|GET /affiliate/search]]
|-
| [[Offerit REST API Decode Trackingcode|GET /affiliate/decode_trackingcode]]
|-
| [[Offerit REST API Edit Affiliate |PATCH /affiliate/edit_affiliate]]
|-
| [[Offerit REST API Set Affiliate Payvia Info|PATCH /affiliate/payvia]]
|-
| [[Offerit REST API Add Affiliate|POST /affiliate/add_affiliate]]
|-
| [[Offerit REST API Affiliate Login Ips|POST /affiliate/affiliate_login_ips]]
|-
! class="i1" | Creative
|-
| [[Offerit REST API Get Creatives |GET /creative/get_creatives]]
|-
| [[Offerit REST API Get Creatives Fields|GET /creative/get_creative_fields]]
|-
| [[Offerit REST API Get Creatives Rules|GET /creative/get_creative_rules]]
|-
| [[Offerit REST API Delete Creative|PATCH /creative/delete_creative]]
|-
| [[Offerit REST API Edit Creative|PATCH /creative/edit_creative]]
|-
| [[Offerit REST API Edit Creative Rules|PATCH /creative/edit_creative_rules]]
|-
| [[Offerit REST API Undelete Creative|PATCH /creative/undelete_creative]]
|-
| [[Offerit REST API Add Creative|POST /creative/add_creative]]
|-
| [[Offerit REST API Add Creative Rule|POST /creative/add_creative_rule]]
|-
| [[Offerit REST API Delete Creative Rules|POST /creative/delete_creative_rules]]
|-
! class="i1" | Customer
|-
| [[Offerit REST API Set Customer Details|PATCH /customer/set_customer_details]]
|-
| [[Offerit REST API Lock Customer|PATCH /customer/lock]]
|-
| [[Offerit REST API Unlock Customer|PATCH /customer/unlock]]
|-
| [[Offerit REST API Forget Customer|PATCH /customer/forget]]
|-
| [[Offerit REST API Export Customer|GET /customer/export]]
|-
! class="i1" | Offer
|-
| [[Offerit REST API Get Conversion Caps|GET /offer/get_conversion_caps]]
|-
| [[Offerit REST API Check Orderid Exists|GET /offer/check_orderid_exists]]
|-
| [[Offerit REST API Get Commission Changes|GET /offer/get_commission_changes]]
|-
| [[Offerit REST API Activate Offer|PATCH /offer/activate_offer]]
|-
| [[Offerit REST API Edit Landing Page |PATCH /offer/edit_landing_page]]
|-
| [[Offerit REST API Edit Offer |PATCH /offer/edit_offer]]
|-
| [[Offerit REST API Pause Offer|PATCH /offer/pause_offer]]
|-
| [[Offerit REST API Set Commission Change Payouts|PATCH /offer/set_commission_change_payouts]]
|-
| [[Offerit REST API Set Enabled Affiliates |PATCH /offer/set_enabled_affiliates]]
|-
| [[Offerit REST API Set Offer Categories|PATCH /offer/set_offer_categories]]
|-
| [[Offerit REST API Set Offer Countries|PATCH /offer/set_offer_countries]]
|-
| [[Offerit REST API Set Offer Goals |PATCH /offer/set_offer_goals]]
|-
| [[Offerit REST API Set Offer Groups |PATCH /offer/set_offer_groups]]
|-
| [[Offerit REST API Set Offer Marketing Types|PATCH /offer/set_offer_marketing_types]]
|-
| [[Offerit REST API Store Offer Ips|PATCH /offer/store_offer_ips]]
|-
| [[Offerit REST API Add Commission Change |POST /offer/add_commission_change]]
|-
| [[Offerit REST API Add Landing Page |POST /offer/add_landing_page]]
|-
| [[Offerit REST API Add Offer |POST /offer/add_offer]]
|-
| [[Offerit REST API Add Tracking Domain |POST /offer/add_tracking_domain]]
|-
! class="i1" | Reporting
|-
| [[Offerit REST API Get Profit Loss Report|GET /report/profitloss]]
|-
| [[Offerit REST API Get Transaction Report|GET /report/transaction]]
|-
! class="i1" | Transaction
|-
| [[Offerit REST API Get Transaction Payout Preview|GET /transaction/transaction_payout_preview]]
|-
| [[Offerit REST API Transaction Update Revenue By Orderid |PATCH /transaction/transaction_update_revenue_by_orderid]]
|-
| [[Offerit REST API Transaction Update Revenue By Transaction Hash |PATCH /transaction/transaction_update_revenue_by_transaction_hash]]
|-
| [[Offerit REST API Process Void |POST /transaction/process_void]]
|-
| [[Offerit REST API Process Chargeback |POST /transaction/process_chargeback]]
|-
| [[Offerit REST API Process Reversal |POST /transaction/process_reversal]]
|-
| [[Offerit REST API Approve Pending Transaction |POST /transaction/approve_pending_transaction]]
|-
| [[Offerit REST API Click Detail |GET /transaction/click_detail]]
|}
{| class="mw-collapsible {{{show_api_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | SOAP API (*deprecated*)
|-
| [[Offerit API|API]]
|-
| [[Offerit API Add Affiliate|Add Affiliate]]
|-
| [[Offerit API Add Affiliate Sale|Add Affiliate Sale]]
|-
| [[Offerit API Add Offer|Add Offer]]
|-
| [[Offerit API Approve Transaction|Approve Transaction]]

|-
| [[Offerit API Creative Types|Creative Types]]
|-
| [[Offerit API Decode Offeritcode|Decode Offeritcode]]
|-
| [[Offerit API Deny Transaction|Deny Transaction]]
|-
| [[Offerit API Disable Affiliate Landing Page|Disable Affiliate Landing Page]]
|-
| [[Offerit API Edit Affiliate Sale|Edit Affiliate Sale]]
|-
| [[Offerit API Enable Affiliate Landing Page|Enable Affiliate Landing Page]]

|-
| [[Offerit API Get Affiliate Stats|Get Affiliate Stats]]
|-
| [[Offerit API Get Allowed Affiliates|Get Allowed Affiliates]]
|-
| [[Offerit API Get Landing Page Details|Get Landing Page Details]]
|-
| [[Offerit API Get Offer Details|Get Offer Details]]
|-
| [[Offerit API Get Offer List|Get Offer List]]
|-
| [[Offerit API Get Profit Loss Report|Get Profit Loss Report]]

|-
| [[Offerit API List Affiliate Details|List Affiliate Details]]
|-
| [[Offerit API List Affiliate Subaffiliates|List Affiliate Subaffiliates]]
|-
| [[Offerit API Ping|Ping]]
|-

|-
| [[Offerit API Set Affiliate Status|Set Affiliate Status]]

|-
| [[Offerit API Set Subaffiliate Status|Set SubAffiliate Status]]

|-
| [[Offerit API Set Member Details|Set Member Details]]
|-
| [[Offerit API Record Affiliate Click|Record Affiliate Click]]
|}
{| class="mw-collapsible {{{show_misc_section|mw-collapsed}}}" width="100%"
! class="i1" | Misc.
|-
| [[Offerit Rules|Rules]]
|-
| [[Offerit Freeform Date|Freeform Date]]
|-

| [[Affiliate Custom Signup]]
|-
| [[Offeritcode]]
|-
| [[Tracking in Offerit]]
|-
| [[Offerit Logos]]
|-
| [[Void Conversions Remotely]]
|-
|}
<hr />


|}<includeonly>[[Category:Offerit]]</includeonly>

Template:Offerit Manual

2019-07-16T17:22:10Z

Offeritnick:

{| class="offeritnavbox"
! [[Offerit|Offerit]]
{| class="mw-collapsible {{{show_for_affiliates_section|mw-collapsed}}}" width="100%"
! class="i1" | For Affiliates
|-
| [[Automatic SubIDs]]
|-
| [[Affiliate Stats Dumps|Affiliate Stats Dumps]]
|-
| [[Linkcode|Linkcode]]
|-
| [[Link Groups|Link Groups]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Host and Post]]

|}
{| class="mw-collapsible {{{show_affiliate_area_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Affiliate Area
|-

| [[Affiliate Account Details]]
|-
| [[Affiliate Account Change Log]]
|-
| [[Offerit Affiliate Creatives|Affiliate Creatives]]
|-
| [[Affiliate Creatives Search]]
|-
| [[Affiliate Settings]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Linkcodes]]
|-
| [[Affiliate Linkcode Settings]]
|-
| [[Affiliate Login History]]
|-
| [[Affiliate Messages]]
|-
| [[Affiliate Dashboard]]
|-
| [[Affiliate Dashboard Key Statistics|Dashboard Key Statistics]]
|-
| [[Affiliate Dashboard Statistics Summary|Dashboard Statistics Summary]]
|-
| [[Affiliate Payment History]]
|-
| [[Quick Links]]
|-
| [[Affiliate Referrals Report]]
|-
| [[Affiliate Referring URL Report]]
|-
| [[Affiliate Remote Login]]
|-
| [[Affiliate Signup]]
|-
| [[Affiliate Statistic Filters]]
|-
| [[Affiliate Statistic Views]]
|-
| [[Affiliate SubIDs]]



|}
{| class="mw-collapsible {{{show_setup_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Setup

|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[Tracking Domain]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]
|-
| [[Getting Started Admin]]
|-
| [[Offerit Quick-Start Guide]]
|-
| [[Tracking in Offerit]]
|-
| [[Pixel Builder]]
|-
| [[Offerit Postback Examples]]
|-
| [[Replacement Variables]]
|-
| [[Offerit Currency Exchange Rates|Currency Exchange Rates]]
|}
<hr />
{| class="mw-collapsible {{{show_admin_overview_section|mw-collapsed}}}" width="100%"
! class="i1" | Admin Dashboard
|-
| [[Admin Dashboard|The Admin Dashboard]]
|}
{| class="mw-collapsible {{{show_reporting_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Reporting Admin
|-
| [[Reporting Admin|The Reporting Admin]]
|-
| [[Track and Strack|Track and Strack]]
|-

|}
{| class="mw-collapsible {{{show_report_breakdowns_section|mw-collapsed}}}" width="100%"
! class="i1" |   Report Breakdowns
|-
| [[Profit and Loss Report|Profit and Loss Report]]
|-
| [[Subscription Report|Subscription Report]]
|-
| [[Transactions Report|Transactions Reports]]

|-
| [[Affiliate Ratios Report|Affiliate Ratios Report]]
|-
| [[Affiliate Managers Report]]
|-
| [[Surfer Actions Report|Visitor Actions Report]]
|-
| [[Affiliate Referral Tier Commissions Report|Referral Tier Payouts Report]]
|-
| [[Affiliate Referral Signup Commissions Report|Referral Signup Payouts Report]]
|-
| [[Additional Commissions Report|Additional Commissions Report]]
|-
| [[Graphical Affiliate Comparison Report|Graphical Affiliate Comparison Report]]
|-
| [[Single Day Comparison Report|The Single Day Comparison Report]]
|-
| [[Actual Affiliate Payments|Actual Affiliate Payments Report]]

|}
{| class="mw-collapsible {{{show_offers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Offers Admin
|-
| [[Offers Admin|The Offers Admin]]
|-
| [[Offers|Offers]]
|-
| [[Offer Setup]]
|-
| [[Affiliate Referrals]]
|-
| [[Tracking Domain]]
|-
| [[Offerit Commission|Commissions]]
|-
| [[Commission Changes]]
|-
| [[Suppression Lists]]
|-
| [[Pixel Builder]]

|-
| [[ID Numbers]]
|-
| [[Offer Partner]]

|-
| [[Offer/Landing Page Redirection]]
|-
| [[Offerit Rules|Setting Rules]]
|-
| [[Admin Host and Post]]
|-
| [[Offer Post URLs]]
|-
| [[Offer Goals]]
|}
{| class="mw-collapsible {{{show_affiliates_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Affiliates Admin
|-
| [[Affiliates Admin|The Affiliates Admin]]
|-
| [[ID Numbers]]
|-
| [[Affiliate Managers]]
|-
| [[Affiliate Referrals]]
|-
| [[Offerit Affiliate Activation|Affiliate Activation]]
|-
| [[Admin-Only Settings]]
|-
| [[Offerit Affiliate Override|Affiliate Overrides]]
|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[In House Accounts|In-House Accounts]]
|-
| [[Add Manual Sale]]
|-
| [[Offerit Manual Invoice|Manual Invoice]]
|-
| [[Offerit Affiliate Documents|Affiliate Documents]]
|-
| [[Affiliate Enabled Offers]]
|-
| [[Change Affiliate Status]]
|-
| [[Account Changes]]
|-
|}
{| class="mw-collapsible {{{show_advertisers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Advertisers Admin
|-
| [[Advertisers Admin|The Advertisers Admin]]
|-
| [[Account Changes]]
|-
| [[Advertiser Invoices]]
|-
| [[Generate Invoice]]
|-
| [[Advertiser Approval]]
|-
| [[Change Advertiser Status]]
|}
{| class="mw-collapsible {{{show_customers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Customers Admin
|-
| [[Customers Admin]]
|-
| [[Offerit Add Customer|Manually Adding a Customer]]
|-
| [[ID Numbers]]
|-
|}

{| class="mw-collapsible {{{show_payments_admin_section|mw-collapsed}}}" width="100%"
! class="i1" |Payments Admin
|-
| [[Payments Admin|The Payments Admin]]
|-
| [[Payvia Types]]
|-
| [[Payout Periods]]
|-
| [[Payvia Dump Formats]]
|-
| [[Payment Dump Entry Numbers |Payment Dump Entry Numbers]]
|-
| [[Offerit Payment Dump Variables|Payment Dump Variables]]
|-
| [[Offerit Check Functions|Check Functions]]
|-
| [[Offerit Rules|Setting Rules]]
|}
{| class="mw-collapsible {{{show_payment_methods_section|mw-collapsed}}}" width="100%"
! class="i1" |Payment Methods
|-
| [[Payza|Payza]]
|}
{| class="mw-collapsible {{{show_creatives_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Creatives Admin
|-
| [[Creatives Admin|The Creatives Admin]]

|-
| [[Offerit Add New Creatives|Add New Creatives]]
|-
| [[Offerit Add New Creative Type|Add New Creative Type]]
|-
| [[Offeritcode]]

|-
| [[Code Builder]]
|-
| [[Track and Strack]]
|-
| [[Offerit Rules|Setting Rules]]
|-
|}
{| class="mw-collapsible {{{show_creative_types_section|mw-collapsed}}}" width="100%"
! class="i1" |   Default Creative Types
|-
| [[Creative Types]]
|-
| [[Offerit Image Banners|Image Banners]]
|-
| [[Offerit Flash Banners|Flash Banners]]
|-
| [[Offerit Dynamic Text Banners|Dynamic Text Banners]]
|-
| [[Offerit Feeds|Feeds]]
|-
| [[Offerit Mailers|Mailers]]
|-
| [[Offerit Downloadable Videos|Video Download]]
|-
| [[Offerit Embedded Videos|Video Embed]]
|-
| [[Offerit Page Peels|Page Peels]]
|-
| [[Offerit IM Popups|IM Popups]]
|-
| [[Offerit Footer Ads|Footer Ads]]
|-
| [[Offerit Page Ads|Page Ads]]
|-
| [[Offerit Overlays|Overlays]]
|-
|}

{| class="mw-collapsible {{{show_communications_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Communications Admin
|-
| [[Communications Admin|The Communications Admin]]
|-
| [[Offerit Add News|Add News Item]]
|-
| [[Offerit Send Message|Sending Messages]]
|-
| [[Signup Questions]]

|}
{| class="mw-collapsible {{{show_configuration_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Configuration Admin
|-
| [[Configuration Admin|The Configuration Admin]]

|-
| [[Offerit Affiliate Signup Postback URL|Affiliate Signup Postback URL]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]

|}

{| class="mw-collapsible {{{show_rest_api_section|mw-collapsed}}}" width="100%"
! class="i1" | REST API
|-
! class="i1" | General
|-
| [[Offerit REST API Overview]]
|-
| [[Offerit REST API Ping|GET /service/ping]]
|-
! class="i1" | Advertiser
|-
| [[Offerit REST API Edit Advertiser |PATCH /advertiser/edit_advertiser]]
|-
| [[Offerit REST API Add Advertiser |POST /advertiser/add_advertiser]]
|-
! class="i1" | Affiliate
|-
| [[Offerit REST API Get Links |GET /affiliate/get_links]]
|-
| [[Offerit REST API Get Single Link |GET /affiliate/get_single_link]]
|-
| [[Offerit REST API Search_Affiliate|GET /affiliate/search]]
|-
| [[Offerit REST API Decode Trackingcode|GET /affiliate/decode_trackingcode]]
|-
| [[Offerit REST API Edit Affiliate |PATCH /affiliate/edit_affiliate]]
|-
| [[Offerit REST API Set Affiliate Payvia Info|PATCH /affiliate/payvia]]
|-
| [[Offerit REST API Add Affiliate|POST /affiliate/add_affiliate]]
|-
| [[Offerit REST API Affiliate Login Ips|POST /affiliate/affiliate_login_ips]]
|-
! class="i1" | Creative
|-
| [[Offerit REST API Get Creatives |GET /creative/get_creatives]]
|-
| [[Offerit REST API Get Creatives Fields|GET /creative/get_creative_fields]]
|-
| [[Offerit REST API Get Creatives Rules|GET /creative/get_creative_rules]]
|-
| [[Offerit REST API Delete Creative|PATCH /creative/delete_creative]]
|-
| [[Offerit REST API Edit Creative|PATCH /creative/edit_creative]]
|-
| [[Offerit REST API Edit Creative Rules|PATCH /creative/edit_creative_rules]]
|-
| [[Offerit REST API Undelete Creative|PATCH /creative/undelete_creative]]
|-
| [[Offerit REST API Add Creative|POST /creative/add_creative]]
|-
| [[Offerit REST API Add Creative Rule|POST /creative/add_creative_rule]]
|-
| [[Offerit REST API Delete Creative Rules|POST /creative/delete_creative_rules]]
|-
! class="i1" | Customer
|-
| [[Offerit REST API Set Customer Details|PATCH /customer/set_customer_details]]
|-
| [[Offerit REST API Lock Customer|PATCH /customer/lock]]
|-
| [[Offerit REST API Unlock Customer|PATCH /customer/unlock]]
|-
| [[Offerit REST API Forget Customer|PATCH /customer/forget]]
|-
| [[Offerit REST API Export Customer|GET /customer/export]]
|-
! class="i1" | Offer
|-
| [[Offerit REST API Get Conversion Caps|GET /offer/get_conversion_caps]
|-
| [[Offerit REST API Check Orderid Exists|GET /offer/check_orderid_exists]]
|-
| [[Offerit REST API Get Commission Changes|GET /offer/get_commission_changes]]
|-
| [[Offerit REST API Activate Offer|PATCH /offer/activate_offer]]
|-
| [[Offerit REST API Edit Landing Page |PATCH /offer/edit_landing_page]]
|-
| [[Offerit REST API Edit Offer |PATCH /offer/edit_offer]]
|-
| [[Offerit REST API Pause Offer|PATCH /offer/pause_offer]]
|-
| [[Offerit REST API Set Commission Change Payouts|PATCH /offer/set_commission_change_payouts]]
|-
| [[Offerit REST API Set Enabled Affiliates |PATCH /offer/set_enabled_affiliates]]
|-
| [[Offerit REST API Set Offer Categories|PATCH /offer/set_offer_categories]]
|-
| [[Offerit REST API Set Offer Countries|PATCH /offer/set_offer_countries]]
|-
| [[Offerit REST API Set Offer Goals |PATCH /offer/set_offer_goals]]
|-
| [[Offerit REST API Set Offer Groups |PATCH /offer/set_offer_groups]]
|-
| [[Offerit REST API Set Offer Marketing Types|PATCH /offer/set_offer_marketing_types]]
|-
| [[Offerit REST API Store Offer Ips|PATCH /offer/store_offer_ips]]
|-
| [[Offerit REST API Add Commission Change |POST /offer/add_commission_change]]
|-
| [[Offerit REST API Add Landing Page |POST /offer/add_landing_page]]
|-
| [[Offerit REST API Add Offer |POST /offer/add_offer]]
|-
| [[Offerit REST API Add Tracking Domain |POST /offer/add_tracking_domain]]
|-
! class="i1" | Reporting
|-
| [[Offerit REST API Get Profit Loss Report|GET /report/profitloss]]
|-
| [[Offerit REST API Get Transaction Report|GET /report/transaction]]
|-
! class="i1" | Transaction
|-
| [[Offerit REST API Get Transaction Payout Preview|GET /transaction/transaction_payout_preview]]
|-
| [[Offerit REST API Transaction Update Revenue By Orderid |PATCH /transaction/transaction_update_revenue_by_orderid]]
|-
| [[Offerit REST API Transaction Update Revenue By Transaction Hash |PATCH /transaction/transaction_update_revenue_by_transaction_hash]]
|-
| [[Offerit REST API Process Void |POST /transaction/process_void]]
|-
| [[Offerit REST API Process Chargeback |POST /transaction/process_chargeback]]
|-
| [[Offerit REST API Process Reversal |POST /transaction/process_reversal]]
|-
| [[Offerit REST API Approve Pending Transaction |POST /transaction/approve_pending_transaction]]
|-
| [[Offerit REST API Click Detail |GET /transaction/click_detail]]
|}
{| class="mw-collapsible {{{show_api_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | SOAP API (*deprecated*)
|-
| [[Offerit API|API]]
|-
| [[Offerit API Add Affiliate|Add Affiliate]]
|-
| [[Offerit API Add Affiliate Sale|Add Affiliate Sale]]
|-
| [[Offerit API Add Offer|Add Offer]]
|-
| [[Offerit API Approve Transaction|Approve Transaction]]

|-
| [[Offerit API Creative Types|Creative Types]]
|-
| [[Offerit API Decode Offeritcode|Decode Offeritcode]]
|-
| [[Offerit API Deny Transaction|Deny Transaction]]
|-
| [[Offerit API Disable Affiliate Landing Page|Disable Affiliate Landing Page]]
|-
| [[Offerit API Edit Affiliate Sale|Edit Affiliate Sale]]
|-
| [[Offerit API Enable Affiliate Landing Page|Enable Affiliate Landing Page]]

|-
| [[Offerit API Get Affiliate Stats|Get Affiliate Stats]]
|-
| [[Offerit API Get Allowed Affiliates|Get Allowed Affiliates]]
|-
| [[Offerit API Get Landing Page Details|Get Landing Page Details]]
|-
| [[Offerit API Get Offer Details|Get Offer Details]]
|-
| [[Offerit API Get Offer List|Get Offer List]]
|-
| [[Offerit API Get Profit Loss Report|Get Profit Loss Report]]

|-
| [[Offerit API List Affiliate Details|List Affiliate Details]]
|-
| [[Offerit API List Affiliate Subaffiliates|List Affiliate Subaffiliates]]
|-
| [[Offerit API Ping|Ping]]
|-

|-
| [[Offerit API Set Affiliate Status|Set Affiliate Status]]

|-
| [[Offerit API Set Subaffiliate Status|Set SubAffiliate Status]]

|-
| [[Offerit API Set Member Details|Set Member Details]]
|-
| [[Offerit API Record Affiliate Click|Record Affiliate Click]]
|}
{| class="mw-collapsible {{{show_misc_section|mw-collapsed}}}" width="100%"
! class="i1" | Misc.
|-
| [[Offerit Rules|Rules]]
|-
| [[Offerit Freeform Date|Freeform Date]]
|-

| [[Affiliate Custom Signup]]
|-
| [[Offeritcode]]
|-
| [[Tracking in Offerit]]
|-
| [[Offerit Logos]]
|-
| [[Void Conversions Remotely]]
|-
|}
<hr />


|}<includeonly>[[Category:Offerit]]</includeonly>

Template:Offerit Manual

2019-07-16T17:21:36Z

Offeritnick:

{| class="offeritnavbox"
! [[Offerit|Offerit]]
{| class="mw-collapsible {{{show_for_affiliates_section|mw-collapsed}}}" width="100%"
! class="i1" | For Affiliates
|-
| [[Automatic SubIDs]]
|-
| [[Affiliate Stats Dumps|Affiliate Stats Dumps]]
|-
| [[Linkcode|Linkcode]]
|-
| [[Link Groups|Link Groups]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Host and Post]]

|}
{| class="mw-collapsible {{{show_affiliate_area_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Affiliate Area
|-

| [[Affiliate Account Details]]
|-
| [[Affiliate Account Change Log]]
|-
| [[Offerit Affiliate Creatives|Affiliate Creatives]]
|-
| [[Affiliate Creatives Search]]
|-
| [[Affiliate Settings]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Linkcodes]]
|-
| [[Affiliate Linkcode Settings]]
|-
| [[Affiliate Login History]]
|-
| [[Affiliate Messages]]
|-
| [[Affiliate Dashboard]]
|-
| [[Affiliate Dashboard Key Statistics|Dashboard Key Statistics]]
|-
| [[Affiliate Dashboard Statistics Summary|Dashboard Statistics Summary]]
|-
| [[Affiliate Payment History]]
|-
| [[Quick Links]]
|-
| [[Affiliate Referrals Report]]
|-
| [[Affiliate Referring URL Report]]
|-
| [[Affiliate Remote Login]]
|-
| [[Affiliate Signup]]
|-
| [[Affiliate Statistic Filters]]
|-
| [[Affiliate Statistic Views]]
|-
| [[Affiliate SubIDs]]



|}
{| class="mw-collapsible {{{show_setup_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Setup

|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[Tracking Domain]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]
|-
| [[Getting Started Admin]]
|-
| [[Offerit Quick-Start Guide]]
|-
| [[Tracking in Offerit]]
|-
| [[Pixel Builder]]
|-
| [[Offerit Postback Examples]]
|-
| [[Replacement Variables]]
|-
| [[Offerit Currency Exchange Rates]]
|}
<hr />
{| class="mw-collapsible {{{show_admin_overview_section|mw-collapsed}}}" width="100%"
! class="i1" | Admin Dashboard
|-
| [[Admin Dashboard|The Admin Dashboard]]
|}
{| class="mw-collapsible {{{show_reporting_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Reporting Admin
|-
| [[Reporting Admin|The Reporting Admin]]
|-
| [[Track and Strack|Track and Strack]]
|-

|}
{| class="mw-collapsible {{{show_report_breakdowns_section|mw-collapsed}}}" width="100%"
! class="i1" |   Report Breakdowns
|-
| [[Profit and Loss Report|Profit and Loss Report]]
|-
| [[Subscription Report|Subscription Report]]
|-
| [[Transactions Report|Transactions Reports]]

|-
| [[Affiliate Ratios Report|Affiliate Ratios Report]]
|-
| [[Affiliate Managers Report]]
|-
| [[Surfer Actions Report|Visitor Actions Report]]
|-
| [[Affiliate Referral Tier Commissions Report|Referral Tier Payouts Report]]
|-
| [[Affiliate Referral Signup Commissions Report|Referral Signup Payouts Report]]
|-
| [[Additional Commissions Report|Additional Commissions Report]]
|-
| [[Graphical Affiliate Comparison Report|Graphical Affiliate Comparison Report]]
|-
| [[Single Day Comparison Report|The Single Day Comparison Report]]
|-
| [[Actual Affiliate Payments|Actual Affiliate Payments Report]]

|}
{| class="mw-collapsible {{{show_offers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Offers Admin
|-
| [[Offers Admin|The Offers Admin]]
|-
| [[Offers|Offers]]
|-
| [[Offer Setup]]
|-
| [[Affiliate Referrals]]
|-
| [[Tracking Domain]]
|-
| [[Offerit Commission|Commissions]]
|-
| [[Commission Changes]]
|-
| [[Suppression Lists]]
|-
| [[Pixel Builder]]

|-
| [[ID Numbers]]
|-
| [[Offer Partner]]

|-
| [[Offer/Landing Page Redirection]]
|-
| [[Offerit Rules|Setting Rules]]
|-
| [[Admin Host and Post]]
|-
| [[Offer Post URLs]]
|-
| [[Offer Goals]]
|}
{| class="mw-collapsible {{{show_affiliates_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Affiliates Admin
|-
| [[Affiliates Admin|The Affiliates Admin]]
|-
| [[ID Numbers]]
|-
| [[Affiliate Managers]]
|-
| [[Affiliate Referrals]]
|-
| [[Offerit Affiliate Activation|Affiliate Activation]]
|-
| [[Admin-Only Settings]]
|-
| [[Offerit Affiliate Override|Affiliate Overrides]]
|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[In House Accounts|In-House Accounts]]
|-
| [[Add Manual Sale]]
|-
| [[Offerit Manual Invoice|Manual Invoice]]
|-
| [[Offerit Affiliate Documents|Affiliate Documents]]
|-
| [[Affiliate Enabled Offers]]
|-
| [[Change Affiliate Status]]
|-
| [[Account Changes]]
|-
|}
{| class="mw-collapsible {{{show_advertisers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Advertisers Admin
|-
| [[Advertisers Admin|The Advertisers Admin]]
|-
| [[Account Changes]]
|-
| [[Advertiser Invoices]]
|-
| [[Generate Invoice]]
|-
| [[Advertiser Approval]]
|-
| [[Change Advertiser Status]]
|}
{| class="mw-collapsible {{{show_customers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Customers Admin
|-
| [[Customers Admin]]
|-
| [[Offerit Add Customer|Manually Adding a Customer]]
|-
| [[ID Numbers]]
|-
|}

{| class="mw-collapsible {{{show_payments_admin_section|mw-collapsed}}}" width="100%"
! class="i1" |Payments Admin
|-
| [[Payments Admin|The Payments Admin]]
|-
| [[Payvia Types]]
|-
| [[Payout Periods]]
|-
| [[Payvia Dump Formats]]
|-
| [[Payment Dump Entry Numbers |Payment Dump Entry Numbers]]
|-
| [[Offerit Payment Dump Variables|Payment Dump Variables]]
|-
| [[Offerit Check Functions|Check Functions]]
|-
| [[Offerit Rules|Setting Rules]]
|}
{| class="mw-collapsible {{{show_payment_methods_section|mw-collapsed}}}" width="100%"
! class="i1" |Payment Methods
|-
| [[Payza|Payza]]
|}
{| class="mw-collapsible {{{show_creatives_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Creatives Admin
|-
| [[Creatives Admin|The Creatives Admin]]

|-
| [[Offerit Add New Creatives|Add New Creatives]]
|-
| [[Offerit Add New Creative Type|Add New Creative Type]]
|-
| [[Offeritcode]]

|-
| [[Code Builder]]
|-
| [[Track and Strack]]
|-
| [[Offerit Rules|Setting Rules]]
|-
|}
{| class="mw-collapsible {{{show_creative_types_section|mw-collapsed}}}" width="100%"
! class="i1" |   Default Creative Types
|-
| [[Creative Types]]
|-
| [[Offerit Image Banners|Image Banners]]
|-
| [[Offerit Flash Banners|Flash Banners]]
|-
| [[Offerit Dynamic Text Banners|Dynamic Text Banners]]
|-
| [[Offerit Feeds|Feeds]]
|-
| [[Offerit Mailers|Mailers]]
|-
| [[Offerit Downloadable Videos|Video Download]]
|-
| [[Offerit Embedded Videos|Video Embed]]
|-
| [[Offerit Page Peels|Page Peels]]
|-
| [[Offerit IM Popups|IM Popups]]
|-
| [[Offerit Footer Ads|Footer Ads]]
|-
| [[Offerit Page Ads|Page Ads]]
|-
| [[Offerit Overlays|Overlays]]
|-
|}

{| class="mw-collapsible {{{show_communications_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Communications Admin
|-
| [[Communications Admin|The Communications Admin]]
|-
| [[Offerit Add News|Add News Item]]
|-
| [[Offerit Send Message|Sending Messages]]
|-
| [[Signup Questions]]

|}
{| class="mw-collapsible {{{show_configuration_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Configuration Admin
|-
| [[Configuration Admin|The Configuration Admin]]

|-
| [[Offerit Affiliate Signup Postback URL|Affiliate Signup Postback URL]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]

|}

{| class="mw-collapsible {{{show_rest_api_section|mw-collapsed}}}" width="100%"
! class="i1" | REST API
|-
! class="i1" | General
|-
| [[Offerit REST API Overview]]
|-
| [[Offerit REST API Ping|GET /service/ping]]
|-
! class="i1" | Advertiser
|-
| [[Offerit REST API Edit Advertiser |PATCH /advertiser/edit_advertiser]]
|-
| [[Offerit REST API Add Advertiser |POST /advertiser/add_advertiser]]
|-
! class="i1" | Affiliate
|-
| [[Offerit REST API Get Links |GET /affiliate/get_links]]
|-
| [[Offerit REST API Get Single Link |GET /affiliate/get_single_link]]
|-
| [[Offerit REST API Search_Affiliate|GET /affiliate/search]]
|-
| [[Offerit REST API Decode Trackingcode|GET /affiliate/decode_trackingcode]]
|-
| [[Offerit REST API Edit Affiliate |PATCH /affiliate/edit_affiliate]]
|-
| [[Offerit REST API Set Affiliate Payvia Info|PATCH /affiliate/payvia]]
|-
| [[Offerit REST API Add Affiliate|POST /affiliate/add_affiliate]]
|-
| [[Offerit REST API Affiliate Login Ips|POST /affiliate/affiliate_login_ips]]
|-
! class="i1" | Creative
|-
| [[Offerit REST API Get Creatives |GET /creative/get_creatives]]
|-
| [[Offerit REST API Get Creatives Fields|GET /creative/get_creative_fields]]
|-
| [[Offerit REST API Get Creatives Rules|GET /creative/get_creative_rules]]
|-
| [[Offerit REST API Delete Creative|PATCH /creative/delete_creative]]
|-
| [[Offerit REST API Edit Creative|PATCH /creative/edit_creative]]
|-
| [[Offerit REST API Edit Creative Rules|PATCH /creative/edit_creative_rules]]
|-
| [[Offerit REST API Undelete Creative|PATCH /creative/undelete_creative]]
|-
| [[Offerit REST API Add Creative|POST /creative/add_creative]]
|-
| [[Offerit REST API Add Creative Rule|POST /creative/add_creative_rule]]
|-
| [[Offerit REST API Delete Creative Rules|POST /creative/delete_creative_rules]]
|-
! class="i1" | Customer
|-
| [[Offerit REST API Set Customer Details|PATCH /customer/set_customer_details]]
|-
| [[Offerit REST API Lock Customer|PATCH /customer/lock]]
|-
| [[Offerit REST API Unlock Customer|PATCH /customer/unlock]]
|-
| [[Offerit REST API Forget Customer|PATCH /customer/forget]]
|-
| [[Offerit REST API Export Customer|GET /customer/export]]
|-
! class="i1" | Offer
|-
| [[Offerit REST API Get Conversion Caps|GET /offer/get_conversion_caps]
|-
| [[Offerit REST API Check Orderid Exists|GET /offer/check_orderid_exists]]
|-
| [[Offerit REST API Get Commission Changes|GET /offer/get_commission_changes]]
|-
| [[Offerit REST API Activate Offer|PATCH /offer/activate_offer]]
|-
| [[Offerit REST API Edit Landing Page |PATCH /offer/edit_landing_page]]
|-
| [[Offerit REST API Edit Offer |PATCH /offer/edit_offer]]
|-
| [[Offerit REST API Pause Offer|PATCH /offer/pause_offer]]
|-
| [[Offerit REST API Set Commission Change Payouts|PATCH /offer/set_commission_change_payouts]]
|-
| [[Offerit REST API Set Enabled Affiliates |PATCH /offer/set_enabled_affiliates]]
|-
| [[Offerit REST API Set Offer Categories|PATCH /offer/set_offer_categories]]
|-
| [[Offerit REST API Set Offer Countries|PATCH /offer/set_offer_countries]]
|-
| [[Offerit REST API Set Offer Goals |PATCH /offer/set_offer_goals]]
|-
| [[Offerit REST API Set Offer Groups |PATCH /offer/set_offer_groups]]
|-
| [[Offerit REST API Set Offer Marketing Types|PATCH /offer/set_offer_marketing_types]]
|-
| [[Offerit REST API Store Offer Ips|PATCH /offer/store_offer_ips]]
|-
| [[Offerit REST API Add Commission Change |POST /offer/add_commission_change]]
|-
| [[Offerit REST API Add Landing Page |POST /offer/add_landing_page]]
|-
| [[Offerit REST API Add Offer |POST /offer/add_offer]]
|-
| [[Offerit REST API Add Tracking Domain |POST /offer/add_tracking_domain]]
|-
! class="i1" | Reporting
|-
| [[Offerit REST API Get Profit Loss Report|GET /report/profitloss]]
|-
| [[Offerit REST API Get Transaction Report|GET /report/transaction]]
|-
! class="i1" | Transaction
|-
| [[Offerit REST API Get Transaction Payout Preview|GET /transaction/transaction_payout_preview]]
|-
| [[Offerit REST API Transaction Update Revenue By Orderid |PATCH /transaction/transaction_update_revenue_by_orderid]]
|-
| [[Offerit REST API Transaction Update Revenue By Transaction Hash |PATCH /transaction/transaction_update_revenue_by_transaction_hash]]
|-
| [[Offerit REST API Process Void |POST /transaction/process_void]]
|-
| [[Offerit REST API Process Chargeback |POST /transaction/process_chargeback]]
|-
| [[Offerit REST API Process Reversal |POST /transaction/process_reversal]]
|-
| [[Offerit REST API Approve Pending Transaction |POST /transaction/approve_pending_transaction]]
|-
| [[Offerit REST API Click Detail |GET /transaction/click_detail]]
|}
{| class="mw-collapsible {{{show_api_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | SOAP API (*deprecated*)
|-
| [[Offerit API|API]]
|-
| [[Offerit API Add Affiliate|Add Affiliate]]
|-
| [[Offerit API Add Affiliate Sale|Add Affiliate Sale]]
|-
| [[Offerit API Add Offer|Add Offer]]
|-
| [[Offerit API Approve Transaction|Approve Transaction]]

|-
| [[Offerit API Creative Types|Creative Types]]
|-
| [[Offerit API Decode Offeritcode|Decode Offeritcode]]
|-
| [[Offerit API Deny Transaction|Deny Transaction]]
|-
| [[Offerit API Disable Affiliate Landing Page|Disable Affiliate Landing Page]]
|-
| [[Offerit API Edit Affiliate Sale|Edit Affiliate Sale]]
|-
| [[Offerit API Enable Affiliate Landing Page|Enable Affiliate Landing Page]]

|-
| [[Offerit API Get Affiliate Stats|Get Affiliate Stats]]
|-
| [[Offerit API Get Allowed Affiliates|Get Allowed Affiliates]]
|-
| [[Offerit API Get Landing Page Details|Get Landing Page Details]]
|-
| [[Offerit API Get Offer Details|Get Offer Details]]
|-
| [[Offerit API Get Offer List|Get Offer List]]
|-
| [[Offerit API Get Profit Loss Report|Get Profit Loss Report]]

|-
| [[Offerit API List Affiliate Details|List Affiliate Details]]
|-
| [[Offerit API List Affiliate Subaffiliates|List Affiliate Subaffiliates]]
|-
| [[Offerit API Ping|Ping]]
|-

|-
| [[Offerit API Set Affiliate Status|Set Affiliate Status]]

|-
| [[Offerit API Set Subaffiliate Status|Set SubAffiliate Status]]

|-
| [[Offerit API Set Member Details|Set Member Details]]
|-
| [[Offerit API Record Affiliate Click|Record Affiliate Click]]
|}
{| class="mw-collapsible {{{show_misc_section|mw-collapsed}}}" width="100%"
! class="i1" | Misc.
|-
| [[Offerit Rules|Rules]]
|-
| [[Offerit Freeform Date|Freeform Date]]
|-

| [[Affiliate Custom Signup]]
|-
| [[Offeritcode]]
|-
| [[Tracking in Offerit]]
|-
| [[Offerit Logos]]
|-
| [[Void Conversions Remotely]]
|-
|}
<hr />


|}<includeonly>[[Category:Offerit]]</includeonly>

Offerit Currency Exchange Rates

2019-07-16T17:20:49Z

Offeritnick:

{{Offerit Manual|show_setup_section=true}}

Ideally, the amounts reported back to Offerit should be a converted amount to your base currency. However, offerit can be used for converting amounts instead. When sending a postback to offerit for a different currency, we will use the exchange rate configured in your Offerit install at the time we receive the postback/pixel call for a transaction. With these details in mind, here are a few potential issues that can occur when using Offerit for converting currencies:
* The exchange rate used by the processor for the transaction does not match up with the exchange rate configured in offerit when the postback/pixel is received
* The exchange rate our source is reporting does not match the rate you want or expect
* The source api fails to return the latest rates

= Automatic Updates *COMING SOON* =
By default Offerit updates conversion rates once a day from https://exchangeratesapi.io/. We have options to decrease this frequency to weekly if you choose. If you would like to update more frequently than this, you can turn OFF the automatic update configuration and use our API to send exchange rate updates.
http://wiki.offerit.com/index.php/Offerit_REST_API_Set_Currency_Exchange_Rates

== Automatic Update Configurations ==
* Automatic Exchange Rate Updates - Turn automatic updates for currency exchange rates on or off.
* Automatic Update Currency List - You can use a comma separated list if you only want to opt-in to automatic updates for specific currencies.
* Automatic Update Exclude Currency List - You can use a comma separated list if you want to opt-out of automatic updates for specific currencies.
* Automatic Update Schedule - Daily is our default, but you can choose weekly updates on a specific day of the week as well.
* Exchange Rate Source - The source API you would like to receive automatic updates from.
* Open Exchange Rates App ID - If you choose "Open Exchange Rates" as your Exchange Rate Soruce, you can use this to set a personal "App ID" for making the API calls to their system.

Offerit Postback Examples

2019-07-16T17:18:40Z

Offeritnick:

{{Offerit Manual|show_setup_section=true}}
= Event Postbacks =
Offerit uses the 'process_pixel.php' script to record events. Below are the examples of different events you may need to send postbacks for, and what parameters are required to record each event type in Offerit.

== Conversion Postback ==
The first transaction for a customer is considered a "conversion". For conversions, the only required field is the 'click_hash' which was generated for a surfer when they went through one of our tracking links:
<pre>http://example.offerit.com/signup/process_pixel.php?click_hash={CLICK_HASH}</pre>

'''Although sending just click_hash will work for recording a conversion event, here are some optional parameters that are commonly sent:'''
*'' subscription_id ''- the Subscription ID is generally a unique customer identifier from your system. Sending a subscription_id allows you to tie future events to the same cusotmer record
*'' amount ''- This parameter is the amount of revenue your network made for the event. It will override the "Conversion Amount" defined on the offer. This allows you to record transactions for any amount rather than just the default amount for the offer. This value should be sent in the base currency for your network. The default is USD, but you can check your network's default in the Config Admin -> Currency - All page. This value should also be in decimal format. For example, if a transaction amount is $9.95, the amount should be sent as "&amount=9.95"

== Continuity Postback ==
Any transaction for a customer after the initial conversion is considered a "continuity". (Ex: Recurring Subscriptions may have periodic continuity transactions sent)
<pre>http://example.offerit.com/signup/process_pixel.php?subscription_id={USER_ID}&orderid={TRANSACTION_ID}</pre>

For continuities, you must send at minimum the subscription_id (same as from conversion postback), and the orderid:
*'' subscription_id ''- the Subscription ID is generally a unique customer identifier from your system. Sending a subscription_id allows you to tie future events to the same cusotmer record
*'' orderid ''- The Order ID is generally a unique identifier for the transaction from your system. Sending us an identifier for your transactions helps us to ensure that if you accidentally send the same transaction postback multiple times, we will only record it once. It also helps with advertiser communication to find and reference transactions if disputes arise.

== Goal Postback ==
For flexibility, Offerit allows you to define your own custom events called "Goals". A common example that is added as a goal is a free registration or signup. When setting up a new Goal, you will be asked to define a "Goal Slug" (ex: freereg). This is slug is what you add to your postbacks to indicate that it is not a normal conversion event, but rather a custom event:
<pre>http://example.offerit.com/signup/process_pixel.php?click_hash={CLICK_HASH}&subscription_id={USER_ID}&goal_slug={GOAL_SLUG}</pre>

Goal postbacks require the following fields:
*'' click_hash '' - This is the same click_hash generated for a surfer when they go through our tracking links. This field is only required if this is the first postback being sent for the customer (before conversion)
*'' subscription_id '' - If this is the first post for the customer, this field will set the customer's ID from your system in Offerit so it can be used for future postbacks instead of click_hash. If this is a follow up post, this will be used to look up the existing customer to insert the Goal transaction in the same customer record.
*'' goal_slug '' - This is the "Goal Slug" defined when adding a new Goal. You can look up your existing goal slugs from the Offers Admin -> Manage Goals page. This indicates what type of transaction you are trying to report.
*'' orderid '' - This field is only required if this is NOT the first postback being sent for the customer (no click_hash). The Order ID is generally a unique identifier for the transaction from your system. Sending us an identifier for your transactions helps us to ensure that if you accidentally send the same transaction postback multiple times, we will only record it once. It also helps with advertiser communication to find and reference transactions if disputes arise.

You can optionally ask us to enable a setting which will require "orderid" for cases where the goal postback is the first postback for a customer.

= Optional Parameters =
The following paremeters can also be sent in your postbacks to be recorded with the customer record:
*'' amount ''- This parameter is the amount of revenue your network made for the event. If the amount for a transaction doesn't match what's defined as the default amount for the event on the offer, you can send this parameter to set the proper transaction amount to be recorded. This value should be sent in the base currency for your network. The default is USD, but you can check your network's default in the Config Admin -> Currency - All page. This value should also be in decimal format. For example, if a transaction amount is $9.95, the amount should be sent as "&amount=9.95". If you have default amounts set on the offer, and you want a $0 transaction, you must pass amount as "zero".
*'' currency ''- This paremeter defines the currency that the "amount" parameter is sent in. The possible 3 letter currency values are listed on the Config Admin -> Currency - All page. This page is also where you would need to manually maintain conversion rates for your install. When Offerit receives a transaction in a currency that is not your base currency, it will automatically convert the amount to the equivalent amount in your base currency for reporting.
*'' username ''
*'' password ''
*'' email ''
*'' ip ''
*'' firstname ''
*'' lastname ''
*'' address1 ''
*'' address2 ''
*'' zip ''
*'' city ''
*'' state ''
*'' country ''
*'' shipping_firstname ''
*'' shipping_lastname ''
*'' shipping_address1 ''
*'' shipping_address2 ''
*'' shipping_zip ''
*'' shipping_city ''
*'' shipping_state ''
*'' shipping_country ''
*'' phone ''
*'' custom1 ''
*'' custom2 ''
*'' custom3 ''
*'' custom4 ''
*'' custom5 ''
''' If you send postbacks with different personal data for the same customer, Offerit will take the latest information sent and update the customer record in question. '''

Template:Offerit Manual

2019-07-16T17:09:34Z

Offeritnick:

{| class="offeritnavbox"
! [[Offerit|Offerit]]
{| class="mw-collapsible {{{show_for_affiliates_section|mw-collapsed}}}" width="100%"
! class="i1" | For Affiliates
|-
| [[Automatic SubIDs]]
|-
| [[Affiliate Stats Dumps|Affiliate Stats Dumps]]
|-
| [[Linkcode|Linkcode]]
|-
| [[Link Groups|Link Groups]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Host and Post]]

|}
{| class="mw-collapsible {{{show_affiliate_area_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Affiliate Area
|-

| [[Affiliate Account Details]]
|-
| [[Affiliate Account Change Log]]
|-
| [[Offerit Affiliate Creatives|Affiliate Creatives]]
|-
| [[Affiliate Creatives Search]]
|-
| [[Affiliate Settings]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Linkcodes]]
|-
| [[Affiliate Linkcode Settings]]
|-
| [[Affiliate Login History]]
|-
| [[Affiliate Messages]]
|-
| [[Affiliate Dashboard]]
|-
| [[Affiliate Dashboard Key Statistics|Dashboard Key Statistics]]
|-
| [[Affiliate Dashboard Statistics Summary|Dashboard Statistics Summary]]
|-
| [[Affiliate Payment History]]
|-
| [[Quick Links]]
|-
| [[Affiliate Referrals Report]]
|-
| [[Affiliate Referring URL Report]]
|-
| [[Affiliate Remote Login]]
|-
| [[Affiliate Signup]]
|-
| [[Affiliate Statistic Filters]]
|-
| [[Affiliate Statistic Views]]
|-
| [[Affiliate SubIDs]]



|}
{| class="mw-collapsible {{{show_setup_section|mw-collapsed}}}" width="100%"
! class="i1" | Offerit Setup

|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[Tracking Domain]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]
|-
| [[Getting Started Admin]]
|-
| [[Offerit Quick-Start Guide]]
|-
| [[Tracking in Offerit]]
|-
| [[Pixel Builder]]
|-
| [[Offerit Postback Examples]]
|-
| [[Replacement Variables]]
|}
<hr />
{| class="mw-collapsible {{{show_admin_overview_section|mw-collapsed}}}" width="100%"
! class="i1" | Admin Dashboard
|-
| [[Admin Dashboard|The Admin Dashboard]]
|}
{| class="mw-collapsible {{{show_reporting_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Reporting Admin
|-
| [[Reporting Admin|The Reporting Admin]]
|-
| [[Track and Strack|Track and Strack]]
|-

|}
{| class="mw-collapsible {{{show_report_breakdowns_section|mw-collapsed}}}" width="100%"
! class="i1" |   Report Breakdowns
|-
| [[Profit and Loss Report|Profit and Loss Report]]
|-
| [[Subscription Report|Subscription Report]]
|-
| [[Transactions Report|Transactions Reports]]

|-
| [[Affiliate Ratios Report|Affiliate Ratios Report]]
|-
| [[Affiliate Managers Report]]
|-
| [[Surfer Actions Report|Visitor Actions Report]]
|-
| [[Affiliate Referral Tier Commissions Report|Referral Tier Payouts Report]]
|-
| [[Affiliate Referral Signup Commissions Report|Referral Signup Payouts Report]]
|-
| [[Additional Commissions Report|Additional Commissions Report]]
|-
| [[Graphical Affiliate Comparison Report|Graphical Affiliate Comparison Report]]
|-
| [[Single Day Comparison Report|The Single Day Comparison Report]]
|-
| [[Actual Affiliate Payments|Actual Affiliate Payments Report]]

|}
{| class="mw-collapsible {{{show_offers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Offers Admin
|-
| [[Offers Admin|The Offers Admin]]
|-
| [[Offers|Offers]]
|-
| [[Offer Setup]]
|-
| [[Affiliate Referrals]]
|-
| [[Tracking Domain]]
|-
| [[Offerit Commission|Commissions]]
|-
| [[Commission Changes]]
|-
| [[Suppression Lists]]
|-
| [[Pixel Builder]]

|-
| [[ID Numbers]]
|-
| [[Offer Partner]]

|-
| [[Offer/Landing Page Redirection]]
|-
| [[Offerit Rules|Setting Rules]]
|-
| [[Admin Host and Post]]
|-
| [[Offer Post URLs]]
|-
| [[Offer Goals]]
|}
{| class="mw-collapsible {{{show_affiliates_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Affiliates Admin
|-
| [[Affiliates Admin|The Affiliates Admin]]
|-
| [[ID Numbers]]
|-
| [[Affiliate Managers]]
|-
| [[Affiliate Referrals]]
|-
| [[Offerit Affiliate Activation|Affiliate Activation]]
|-
| [[Admin-Only Settings]]
|-
| [[Offerit Affiliate Override|Affiliate Overrides]]
|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[In House Accounts|In-House Accounts]]
|-
| [[Add Manual Sale]]
|-
| [[Offerit Manual Invoice|Manual Invoice]]
|-
| [[Offerit Affiliate Documents|Affiliate Documents]]
|-
| [[Affiliate Enabled Offers]]
|-
| [[Change Affiliate Status]]
|-
| [[Account Changes]]
|-
|}
{| class="mw-collapsible {{{show_advertisers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Advertisers Admin
|-
| [[Advertisers Admin|The Advertisers Admin]]
|-
| [[Account Changes]]
|-
| [[Advertiser Invoices]]
|-
| [[Generate Invoice]]
|-
| [[Advertiser Approval]]
|-
| [[Change Advertiser Status]]
|}
{| class="mw-collapsible {{{show_customers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Customers Admin
|-
| [[Customers Admin]]
|-
| [[Offerit Add Customer|Manually Adding a Customer]]
|-
| [[ID Numbers]]
|-
|}

{| class="mw-collapsible {{{show_payments_admin_section|mw-collapsed}}}" width="100%"
! class="i1" |Payments Admin
|-
| [[Payments Admin|The Payments Admin]]
|-
| [[Payvia Types]]
|-
| [[Payout Periods]]
|-
| [[Payvia Dump Formats]]
|-
| [[Payment Dump Entry Numbers |Payment Dump Entry Numbers]]
|-
| [[Offerit Payment Dump Variables|Payment Dump Variables]]
|-
| [[Offerit Check Functions|Check Functions]]
|-
| [[Offerit Rules|Setting Rules]]
|}
{| class="mw-collapsible {{{show_payment_methods_section|mw-collapsed}}}" width="100%"
! class="i1" |Payment Methods
|-
| [[Payza|Payza]]
|}
{| class="mw-collapsible {{{show_creatives_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Creatives Admin
|-
| [[Creatives Admin|The Creatives Admin]]

|-
| [[Offerit Add New Creatives|Add New Creatives]]
|-
| [[Offerit Add New Creative Type|Add New Creative Type]]
|-
| [[Offeritcode]]

|-
| [[Code Builder]]
|-
| [[Track and Strack]]
|-
| [[Offerit Rules|Setting Rules]]
|-
|}
{| class="mw-collapsible {{{show_creative_types_section|mw-collapsed}}}" width="100%"
! class="i1" |   Default Creative Types
|-
| [[Creative Types]]
|-
| [[Offerit Image Banners|Image Banners]]
|-
| [[Offerit Flash Banners|Flash Banners]]
|-
| [[Offerit Dynamic Text Banners|Dynamic Text Banners]]
|-
| [[Offerit Feeds|Feeds]]
|-
| [[Offerit Mailers|Mailers]]
|-
| [[Offerit Downloadable Videos|Video Download]]
|-
| [[Offerit Embedded Videos|Video Embed]]
|-
| [[Offerit Page Peels|Page Peels]]
|-
| [[Offerit IM Popups|IM Popups]]
|-
| [[Offerit Footer Ads|Footer Ads]]
|-
| [[Offerit Page Ads|Page Ads]]
|-
| [[Offerit Overlays|Overlays]]
|-
|}

{| class="mw-collapsible {{{show_communications_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Communications Admin
|-
| [[Communications Admin|The Communications Admin]]
|-
| [[Offerit Add News|Add News Item]]
|-
| [[Offerit Send Message|Sending Messages]]
|-
| [[Signup Questions]]

|}
{| class="mw-collapsible {{{show_configuration_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Configuration Admin
|-
| [[Configuration Admin|The Configuration Admin]]

|-
| [[Offerit Affiliate Signup Postback URL|Affiliate Signup Postback URL]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]

|}

{| class="mw-collapsible {{{show_rest_api_section|mw-collapsed}}}" width="100%"
! class="i1" | REST API
|-
! class="i1" | General
|-
| [[Offerit REST API Overview]]
|-
| [[Offerit REST API Ping|GET /service/ping]]
|-
! class="i1" | Advertiser
|-
| [[Offerit REST API Edit Advertiser |PATCH /advertiser/edit_advertiser]]
|-
| [[Offerit REST API Add Advertiser |POST /advertiser/add_advertiser]]
|-
! class="i1" | Affiliate
|-
| [[Offerit REST API Get Links |GET /affiliate/get_links]]
|-
| [[Offerit REST API Get Single Link |GET /affiliate/get_single_link]]
|-
| [[Offerit REST API Search_Affiliate|GET /affiliate/search]]
|-
| [[Offerit REST API Decode Trackingcode|GET /affiliate/decode_trackingcode]]
|-
| [[Offerit REST API Edit Affiliate |PATCH /affiliate/edit_affiliate]]
|-
| [[Offerit REST API Set Affiliate Payvia Info|PATCH /affiliate/payvia]]
|-
| [[Offerit REST API Add Affiliate|POST /affiliate/add_affiliate]]
|-
| [[Offerit REST API Affiliate Login Ips|POST /affiliate/affiliate_login_ips]]
|-
! class="i1" | Creative
|-
| [[Offerit REST API Get Creatives |GET /creative/get_creatives]]
|-
| [[Offerit REST API Get Creatives Fields|GET /creative/get_creative_fields]]
|-
| [[Offerit REST API Get Creatives Rules|GET /creative/get_creative_rules]]
|-
| [[Offerit REST API Delete Creative|PATCH /creative/delete_creative]]
|-
| [[Offerit REST API Edit Creative|PATCH /creative/edit_creative]]
|-
| [[Offerit REST API Edit Creative Rules|PATCH /creative/edit_creative_rules]]
|-
| [[Offerit REST API Undelete Creative|PATCH /creative/undelete_creative]]
|-
| [[Offerit REST API Add Creative|POST /creative/add_creative]]
|-
| [[Offerit REST API Add Creative Rule|POST /creative/add_creative_rule]]
|-
| [[Offerit REST API Delete Creative Rules|POST /creative/delete_creative_rules]]
|-
! class="i1" | Customer
|-
| [[Offerit REST API Set Customer Details|PATCH /customer/set_customer_details]]
|-
| [[Offerit REST API Lock Customer|PATCH /customer/lock]]
|-
| [[Offerit REST API Unlock Customer|PATCH /customer/unlock]]
|-
| [[Offerit REST API Forget Customer|PATCH /customer/forget]]
|-
| [[Offerit REST API Export Customer|GET /customer/export]]
|-
! class="i1" | Offer
|-
| [[Offerit REST API Get Conversion Caps|GET /offer/get_conversion_caps]
|-
| [[Offerit REST API Check Orderid Exists|GET /offer/check_orderid_exists]]
|-
| [[Offerit REST API Get Commission Changes|GET /offer/get_commission_changes]]
|-
| [[Offerit REST API Activate Offer|PATCH /offer/activate_offer]]
|-
| [[Offerit REST API Edit Landing Page |PATCH /offer/edit_landing_page]]
|-
| [[Offerit REST API Edit Offer |PATCH /offer/edit_offer]]
|-
| [[Offerit REST API Pause Offer|PATCH /offer/pause_offer]]
|-
| [[Offerit REST API Set Commission Change Payouts|PATCH /offer/set_commission_change_payouts]]
|-
| [[Offerit REST API Set Enabled Affiliates |PATCH /offer/set_enabled_affiliates]]
|-
| [[Offerit REST API Set Offer Categories|PATCH /offer/set_offer_categories]]
|-
| [[Offerit REST API Set Offer Countries|PATCH /offer/set_offer_countries]]
|-
| [[Offerit REST API Set Offer Goals |PATCH /offer/set_offer_goals]]
|-
| [[Offerit REST API Set Offer Groups |PATCH /offer/set_offer_groups]]
|-
| [[Offerit REST API Set Offer Marketing Types|PATCH /offer/set_offer_marketing_types]]
|-
| [[Offerit REST API Store Offer Ips|PATCH /offer/store_offer_ips]]
|-
| [[Offerit REST API Add Commission Change |POST /offer/add_commission_change]]
|-
| [[Offerit REST API Add Landing Page |POST /offer/add_landing_page]]
|-
| [[Offerit REST API Add Offer |POST /offer/add_offer]]
|-
| [[Offerit REST API Add Tracking Domain |POST /offer/add_tracking_domain]]
|-
! class="i1" | Reporting
|-
| [[Offerit REST API Get Profit Loss Report|GET /report/profitloss]]
|-
| [[Offerit REST API Get Transaction Report|GET /report/transaction]]
|-
! class="i1" | Transaction
|-
| [[Offerit REST API Get Transaction Payout Preview|GET /transaction/transaction_payout_preview]]
|-
| [[Offerit REST API Transaction Update Revenue By Orderid |PATCH /transaction/transaction_update_revenue_by_orderid]]
|-
| [[Offerit REST API Transaction Update Revenue By Transaction Hash |PATCH /transaction/transaction_update_revenue_by_transaction_hash]]
|-
| [[Offerit REST API Process Void |POST /transaction/process_void]]
|-
| [[Offerit REST API Process Chargeback |POST /transaction/process_chargeback]]
|-
| [[Offerit REST API Process Reversal |POST /transaction/process_reversal]]
|-
| [[Offerit REST API Approve Pending Transaction |POST /transaction/approve_pending_transaction]]
|-
| [[Offerit REST API Click Detail |GET /transaction/click_detail]]
|}
{| class="mw-collapsible {{{show_api_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | SOAP API (*deprecated*)
|-
| [[Offerit API|API]]
|-
| [[Offerit API Add Affiliate|Add Affiliate]]
|-
| [[Offerit API Add Affiliate Sale|Add Affiliate Sale]]
|-
| [[Offerit API Add Offer|Add Offer]]
|-
| [[Offerit API Approve Transaction|Approve Transaction]]

|-
| [[Offerit API Creative Types|Creative Types]]
|-
| [[Offerit API Decode Offeritcode|Decode Offeritcode]]
|-
| [[Offerit API Deny Transaction|Deny Transaction]]
|-
| [[Offerit API Disable Affiliate Landing Page|Disable Affiliate Landing Page]]
|-
| [[Offerit API Edit Affiliate Sale|Edit Affiliate Sale]]
|-
| [[Offerit API Enable Affiliate Landing Page|Enable Affiliate Landing Page]]

|-
| [[Offerit API Get Affiliate Stats|Get Affiliate Stats]]
|-
| [[Offerit API Get Allowed Affiliates|Get Allowed Affiliates]]
|-
| [[Offerit API Get Landing Page Details|Get Landing Page Details]]
|-
| [[Offerit API Get Offer Details|Get Offer Details]]
|-
| [[Offerit API Get Offer List|Get Offer List]]
|-
| [[Offerit API Get Profit Loss Report|Get Profit Loss Report]]

|-
| [[Offerit API List Affiliate Details|List Affiliate Details]]
|-
| [[Offerit API List Affiliate Subaffiliates|List Affiliate Subaffiliates]]
|-
| [[Offerit API Ping|Ping]]
|-

|-
| [[Offerit API Set Affiliate Status|Set Affiliate Status]]

|-
| [[Offerit API Set Subaffiliate Status|Set SubAffiliate Status]]

|-
| [[Offerit API Set Member Details|Set Member Details]]
|-
| [[Offerit API Record Affiliate Click|Record Affiliate Click]]
|}
{| class="mw-collapsible {{{show_misc_section|mw-collapsed}}}" width="100%"
! class="i1" | Misc.
|-
| [[Offerit Rules|Rules]]
|-
| [[Offerit Freeform Date|Freeform Date]]
|-

| [[Affiliate Custom Signup]]
|-
| [[Offeritcode]]
|-
| [[Tracking in Offerit]]
|-
| [[Offerit Logos]]
|-
| [[Void Conversions Remotely]]
|-
|}
<hr />


|}<includeonly>[[Category:Offerit]]</includeonly>

Offerit Currency Exchange Rates

2019-07-16T16:59:23Z

Offeritnick:

{{Offerit Manual
| show_setup_section = true
}}

Ideally, the amounts reported back to Offerit should be a converted amount to your base currency. However, offerit can be used for converting amounts instead. When sending a postback to offerit for a different currency, we will use the exchange rate configured in your Offerit install at the time we receive the postback/pixel call for a transaction. With these details in mind, here are a few potential issues that can occur when using Offerit for converting currencies:
* The exchange rate used by the processor for the transaction does not match up with the exchange rate configured in offerit when the postback/pixel is received
* The exchange rate our source is reporting does not match the rate you want or expect
* The source api fails to return the latest rates

= Automatic Updates *COMING SOON* =
By default Offerit updates conversion rates once a day from https://exchangeratesapi.io/. We have options to decrease this frequency to weekly if you choose. If you would like to update more frequently than this, you can turn OFF the automatic update configuration and use our API to send exchange rate updates.
http://wiki.offerit.com/index.php/Offerit_REST_API_Set_Currency_Exchange_Rates

== Automatic Update Configurations ==
* Automatic Exchange Rate Updates - Turn automatic updates for currency exchange rates on or off.
* Automatic Update Currency List - You can use a comma separated list if you only want to opt-in to automatic updates for specific currencies.
* Automatic Update Exclude Currency List - You can use a comma separated list if you want to opt-out of automatic updates for specific currencies.
* Automatic Update Schedule - Daily is our default, but you can choose weekly updates on a specific day of the week as well.
* Exchange Rate Source - The source API you would like to receive automatic updates from.
* Open Exchange Rates App ID - If you choose "Open Exchange Rates" as your Exchange Rate Soruce, you can use this to set a personal "App ID" for making the API calls to their system.