The purpose of the Sources page of your account

Use the Sources page of your Rbate account to register your Help Sources with Rbate and view their earnings and rankings. Each Help Source is either an online or offline medium that assists consumers (an article, clip, interactive tool, publication, comment, etc.), or a consumer assistance service (an organization, premises, person, or facility).

Rcodes and Rmarks

Each registered source is allocated a unique alpha-numeric Rcode that is displayed in the source table and at the top of each source's form once it is saved.

Rcodes are used to identify your source when consumers add it to their collection of Rmarks (their annotatable library of product research). Rebate claimers cite your source as helpful on rebate claims by selecting their Rmark of your source.

A consumer can Rmark a source via am Rmark button on a webpage or a short URL or QR image on offline material; or you can give someone an Rmark yourself by requesting their email address. Instructions on how to do each of these can be found here.

Each source must be individually registered or linked to a group or a comment host

A Help Source cannot be cited by a rebate claimer, and so earn you Rbate income and citation credit, unless (1), you have individually registered that source with Rbate, either via the form on the Sources Page, or by having your systems call Rbate's API, (2), you have registered a Help Source that represents a (media or service) source group, and use the group Rcode to associate individual sources within this group with the group as a whole, (3), you have registered a Help Source that represents a media group, which allows individual Web-based sources within this group to be automatically registered with Rbate when first Rmarked from an Rmark button you place on it, or (4), the source is a user comment that can be matched by Rcode or URL to a media source on which you've set the Comment Permalink Prefix field. User comment sources aren't listed on the Sources Page.

You can manually register single sources, or only source groups

It's best if you can register as many of your individual sources with Rbate, preferably close to their time of first availability. Registering a source adds it to Rbate's search engine, allocates it a unique Rcode, and allows you to view separate earnings and statistics.

If you run a service, you can choose what level of detail to register, from individual staff members, to individual premises, regions, or just a single source for each service type. A finer division of sources allows you to track their individual performance. Use the "Parent source" field to group sources in their proper hierarchy.

If your organization creates media, and you find it too much work to pre-register all your individual pieces as Help Sources, you can instead register sources of the "Media group" type. Each may represent a particular masthead or website, or one section of such. Even if you do pre-register some or all of your individual media sources, it can be convenient to organize them in Media Groups.

If you choose to use such group sources for your offline media, the Rcode that you should display on your individual media pieces should be the Rcode of its most specific group. Rebate claimers cite a source as helpful by Rmarking the group source, which can earn the publication that the group represents both income and increased search engine ranking. However no citation credit or income can accrue to the individual piece until you register it separately.

In contrast, for your online material, smarter behaviour is possible when you choose not to pre-register some individual sources:

If you have registered complete websites or website sections with Rbate (which can also represent printed sections), then when you place an Rmark button on each page of your individual unregistered pieces you should try to set the the button's rcode parameter to that of the most specific Media Group for the piece, and also try to either set either the button's first_page_url parameter to the URL of the first webpage of the piece, or the url parameter to that of the webpage that's being rendered.

If your web-app makes it hard to set page-specific parameters, they can often be left off the button HTML, and an attempt will be made to determine them automatically. However leaving off the URL parameters will cause problems with some browsers and pages, while leaving off the Rcode is only possible when the URLs of all pieces in the group begin with the URL you've set for the group source itself.

For more details, see Getting Rmarked.

Automatic registration of online sources within a Media Group

When a visitor Rmarks one of your Web-based pieces (either automatically when the page is visited because the user has enabled auto-Rmarking, or when the Rmark button is explicitly clicked), and Rbate can't link that piece to an existing individual registered Help Source via Rcode or URL, but can to a registered Media Group, Rbate will automatically register a source for that individual piece, and allocate it an Rcode. This will enable that source to be separately listed in Rbate's search engine, and earnings and statistics can be separately displayed.

This new source will inherit the product category and product list from the group in question, and a heading/title and description from the webpage in question. You will be notified of the source's creation by email, and prompted to edit the new source to set a correct media type, product category, product list, and any other fields. It's also desirable to update the Rmark buttons on the source's pages to use the newly-allocated individual one, rather than the Rcode of the group.

It's important that each source be given the most specific possible product category, allowing your sources to be listed prominently in Rbate claim citation candidate lists whenever its category is a tight match for the product that has been bought. Correct titles, descriptions, media types, and product lists also allow your source to be found more easily by shoppers using Rbate's search engine.

For this reason you should either (1) register all sources pre-publication via the Sources Page or the API, (2), create Media Group sources and respond diligently to requests to edit individual sources after they've been automatically created, or (3), create Media Group sources with highly specific categories (e.g. by using sources that represent publication sections or topics that have the whole publication as a parent source), and allow these to be linked to individual pieces by either including the group's Rcode on piece Rmark buttons, or by ensuring that the URLs of your site are arranged so that the URL you set for the group source is not only the group's "home page", but is also a prefix of the URLs of all pieces in that group.

Creating and Updating Sources through the API

You can use Rbate's API to allow your Content Management System or other sotfware to create and edit your registered Rbate sources outside the usual Web interface of your Rbate Helper Account.

This can be done by POSTing the following parameters to

https://rbate.com/helpers/set_source

PARAMETER NAME REQUIRED? PARAMETER VALUE
rcode N

The Rcode of the source to be updated. Do not include this parameter when creating a new source.

key Y

Your API key. Log-in to see.

handle Y

A unique handle for the source of at most 25 characters.

type_name Y

A string that represents the type of source this is.

Media
singleReview of a single product
comparativeA comparative review
guideA buyers' guide or commentary
digestA summary of other reviews
packageA review of a product bundle
rbate_advisorAn Rbate online purchase advisor
custom_advisorA non-Rbate purchase advisor
informationProduct information
pub_groupMedia group (website, periodical, channel, etc.)
price_and_availabilityPrice & availability information
forumA discussion forum
whats_newA "What's New" list
Services
choice_consultancyA choice consultancy (inc. stores)
Other
personA Person: A content creator or choice consultant
single_recommendationA single recommendation having contributing Rcodes
filter_groupA group specified by a filter
title Y

Title or name of the source. At most 100 characters.

url N

The cannonical URL of the first page of the source.

content_changed N

Set to 'Y' to trigger a re-spider of the content.

tags N

A space-separated list of tags that help filter sources in your account.

group_filter N

Only for filter group sources: The search terms that define the group.

area_served N

A unique comma-separated expanding placename hierarchy subset that encompases the locations served by this service or price/availability source. Placenames should be taken from the Rbate location selector.

For example

Sydney, Australia

The state "NSW" cam be skipped because this two-placename subset is globally unique.

A blank or missing value specifices a global area is served.

specific_area_served N

If a most-specific setting of the area_served parameter is not sufficiently precise, refine the location(s) by also setting this parameter.

location N

A unique comma-separated expanding placename hierarchy subset that encompases the location(s) of a service source. Placenames should be taken from the Rbate location selector. See area_served above. A blank or missing value specifices a global area is served.

specific_location N

If a most-specific setting of the location parameter is not sufficiently precise, refine the location(s) by also setting this parameter.

postal_code N

The postcode of this service source.

latitude N

The latitude of this service source in degrees (-90 to 90). If left blank, an attempt will be made to automatically determine it from a postal_code value.

longitude N

The longitude of this service source in degrees (-180 to 180). If left blank, an attempt will be made to automatically determine it from a postal_code value.

info_service N

Set to "Y" for service sources that provide consumers with product information.

info_service N

Set to "Y" for service sources that provide consumers with product information.

recommend_service N

Set to "Y" for service sources that provide consumers with product recommentations.

demo_service N

Set to "Y" for service sources that provide consumers with product demonstrations.

demo_service N

Set to "Y" for service sources that provide consumers with product demonstrations.

trial_service N

Set to "Y" for service sources that provide consumers with product trials.

purchasing_service N

Set to "Y" for service sources that provide consumers with product purchasing or gift services.

phone_area_code N

The area code of a service source (omitting out-of-area access prefix)

phone_number N

The local phone number of a service source.

phone_time_start
phone_time_end
N

For service sources, set the hours over which its phone service is available, relative to time zone of the source's location. Each parameter should be set to HH or HH:MM (both 24-hour clock). For 24-hour services, set to 00 or leave blank.

phone_mon
phone_mon
phone_tue
phone_wed
phone_thu
phone_fri
phone_sat
phone_sun
N

For service sources, set the parameter to "Y" if the phone service is available on that day.

net_delivery
phone_delivery
customer_prem_delivery
provider_prem_delivery
N

Set each to "Y" if this source delivers services repsectively via the Internet, phone, the customer's premises, and your own premises.

sales_service N

Set to "Y" if this source sells the products on which it provides advice.

parent_source N

The rcode of the immediate parent media_group or service source to which this source belongs. Chains of sources can be created. e.g. salesperson-department-store-state-chain, or article-section-newspaper. Use the author field for authors of media sources.

publication_date N

The date the source was first made publicly available, in YYYY-MM-DD format.

publication_reference N

A descrption of where an offline media source can be found.

expert_level N

Set to "Y" if this is a media source that contains expert-level material.

product_category N

A unique comma-separated expanding product category hierarchy subset that encompases all the source's content or work. Categories should be taken from the Rbate product category selector.

For example

Other, Audio

uniquely specifies the category hierarchy Other, Audio, Audio/Video/Image, Electronics, Goods (you can own)

A blank or missing value specifices unrestricted subject matter, but it's important to be as specific as possible to best highlight your source in rebate claims and search engine results.

Select an "Other Topic" category for sources that are unlikely to influence product purchases, but which people may still like to Rmark to compile their research on this topic.

specific_product_category N

If a most-specific product_category setting is not sufficiently precise, refine the category(s) by also setting this parameter.

product_availability N

A unique comma-separated expanding location hierarchy subset that encompases all regions where the products covered by the source's content or work are available. Locations should be taken from the Rbate location category selector. See the area_served parameter.

A blank or missing value specifices global product availability, but it's important to be as specific as possible to best highlight your source in rebate claims and search engine results.

specific_product_availability N

If a most-specific product_availability setting is not sufficiently precise, refine the location(s) by also setting this parameter.

not_charged N

Set to "Y" if there is no charge to access the media or service of this source.

service_fee N

A decimal currency value, set only if the source charges a uniform access/use fee.

service_fee_currency N

If the service_fee parameter is set, a three-letter string that represents the currency of the service_fee amount. The following are valid:

USDUS Dollars
AUDAustralian Dollars
GBPBritish Pounds
NZDNew Zealand Dollars
CADCanadian Dollars
ZARSouth African Rand
EUREuros
SGDSingapore Dollars
deferred_charge N

If the service_fee parameter is set, set this to "Y" if the service fee is not charged up-front, but recovered from Rbate-managed rebates.

donation_info_url N

The URL of a webpage where you can encourage rebate claimers to donate part of their rebates to this source that they found helpful, including description of any acknowledgement or benefit given in return.

products_involved N

A comma-separated list of products with which this source refers or works. Each product should have the form:

[brand/maker name]:[title/model-id]:[R]

Where [R] is "Y" if the [title/brand-id] string is a regular expression rather than a litteral ([R] = "N"). The special brand and model value "all" can be used.

contributing_sources N

A comma-separated list of contributions to this source by other sources. Each contribution should have the form:

[Rcode]:[Percentage-Contribution]

description N

A plain-text description of the source in at most 500 characters and 5 paragraphs.

disclosure N

A plain-text (max 255 characters) voluntary disclosure of any relationships which could be interpreted as affecting your work on this source, augmenting any disclosure in your Helper editorial policy statement that applies to all your sources.

indexing_wanted N

Set to "Y" if you want this source to appear in results of Rbate's purchasing help search engine.

When a source is sucessfully created or edited, the response status will be 200 and the response body will be the source's Rcode. Otherwise a different status is returned and the response body will contain an error-message string.