2010년 8월 25일 수요일

[프로그래밍] http://developer.compete.com/


Compete Developer Resources




Compete Site Analytics - provides information for every site on the internet including site traffic history and competitive analytics; a list of available promotional codes across thousands of online retailers; and site-specific trust scores based on up-to-the-minute data from Compete and third party security services.


Your site or application can display some of Compete's most powerful data by using the Compete Site Analytics API.


 


How do I get started?



  1. Read the Terms of Use and Branding Requirements to make sure your integration adheres to the fine print.
  2. Read the Technical Documentation below to get instructions for making Web Service calls.
  3. Register for a developer user account.
  4. Register your application to get your personal API key.
  5. Start coding — be sure to use your APIKEY to make your API calls.

Please note that the Compete API is being handled by Mashery. You may receive some emails regarding the Compete API via Mashery and not Compete directly. Contact Jay Meattle (jmeattle@compete.com) if you have questions.


 


Technical Documentation & Code samples

The Web Service is located at:


http://api.compete.com/fast-cgi/MI


Sample Call for Google.com:


http://api.compete.com/fast-cgi/MI?d=google.com&ver=3&apikey=1234567890&size=large


API Parameters























Parameter Description Required
d Domain name identifier Yes
ver API version identifier (latest: ver=3) Yes
apikey Each subscriber to Compete’s Web Services is uniquely identified by an ID sequence and every request to Web services requires this ID. Yes
size Icon size identifier (values: small, large - default) No

Sample Output



<ci>
      <dmn>
            <nm>google.com</nm>
            <trust caption="Trust">
                  <val>green</val>
                  <link>http://toolbar.compete.com/trustgreen/google.com</link>
                  <icon>http://home.compete.com.edgesuite.net/site_media/images/icons/trust_green_53.gif</icon>
            </trust>
            <rank caption="Profile">
                  <val>2</val>
                  <link>http://toolbar.compete.com/siteprofile/google.com</link>
                  <icon>http://home.compete.com.edgesuite.net/site_media/images/icons/profile_3_53.gif</icon>
            </rank>
            <metrics caption="Profile">
                  <val>
                        <mth>12</mth>
                        <yr>2006</yr>
                        <uv>
                             <ranking>2</ranking>
                             <count>115,120,111</count>
                        </uv>
                  </val>
                  <link>http://toolbar.compete.com/siteprofile/google.com</link>
                  <icon>http://home.compete.com.edgesuite.net/site_media/images/icons/profile_3_53.gif</icon>
            </metrics>
            <deals caption="Deals">
                  <val>1</val>
                  <link>http://toolbar.compete.com/deals/google.com</link>
                  <icon>http://home.compete.com.edgesuite.net/site_media/images/icons/deals_on_53.gif</icon>
            </deals>
      </dmn>
</ci>


For a specified domain (d), the Compete SnapShot API returns:


1. Trust Rating:


            <trust caption="Trust">
                  <val>green</val>
                  <link>http://toolbar.compete.com/trustgreen/google.com</link>
                  <icon>http://home.compete.com.edgesuite.net/site_media/images/icons/trust_green_53.gif</icon>
            </trust>
















val Trust Summary
green Trusted
yellow Neutral
red Caution
















link Link to corresponding Trust summary page
http://toolbar.compete.com/trustgreen/google.com Trusted
http://toolbar.compete.com/trustyellow/google.com Neutral
http://toolbar.compete.com/trustred/google.com Caution
































size icon Link to corresponding “Trust” icon image
small http://home.compete.com.edgesuite.net/site_media/images/icons/trust_green_16.gif
small http://home.compete.com.edgesuite.net/site_media/images/icons/trust_yellow_16.gif
small http://home.compete.com.edgesuite.net/site_media/images/icons/trust_red_16.gif
large http://home.compete.com.edgesuite.net/site_media/images/icons/trust_green_53.gif
large http://home.compete.com.edgesuite.net/site_media/images/icons/trust_yellow_53.gif
large http://home.compete.com.edgesuite.net/site_media/images/icons/trust_red_53.gif

2. Traffic Profile:


            <metrics caption="Profile">
                  <val>
                        <mth>12</mth>
                        <yr>2006</yr>
                        <uv>
                             <ranking>2</ranking>
                             <count>115,120,111</count>
                        </uv>
                  </val>
                  <link>http://toolbar.compete.com/siteprofile/google.com</link>
                  <icon>http://home.compete.com.edgesuite.net/site_media/images/icons/profile_3_53.gif</icon>
            </metrics>
















mth Month
yr Year
ranking Domain ranking based on Unique Visitor estimate for month/year
count Unique Visitor estimate for the month/year










link Link to corresponding Traffic summary page
http://toolbar.compete.com/siteprofile/google.com Available








































size icon Link to corresponding “Traffic” icon image
small http://home.compete.com.edgesuite.net/site_media/images/icons/profile_3_16.gif
small http://home.compete.com.edgesuite.net/site_media/images/icons/profile_2_16.gif
small http://home.compete.com.edgesuite.net/site_media/images/icons/profile_1_16.gif
small http://home.compete.com.edgesuite.net/site_media/images/icons/profile_0_16.gif
large http://home.compete.com.edgesuite.net/site_media/images/icons/profile_3_53.gif
large http://home.compete.com.edgesuite.net/site_media/images/icons/profile_2_53.gif
large http://home.compete.com.edgesuite.net/site_media/images/icons/profile_1_53.gif
large http://home.compete.com.edgesuite.net/site_media/images/icons/profile_0_53.gif

3. Deals:


            <deals caption="Deals">
                  <val>1</val>
                  <link>http://toolbar.compete.com/deals/google.com</link>
                  <icon>http://home.compete.com.edgesuite.net/site_media/images/icons/deals_off_53.gif</icon>
            </deals>













val Deals Available
1 Yes
0 No













link Link to Deals summary page (if deals available)
http://toolbar.compete.com/deals/google.com Available
n/a None available
























size icon Link to corresponding “Deal” icon image
small http://home.compete.com.edgesuite.net/site_media/images/icons/deals_on_16.gif
small http://home.compete.com.edgesuite.net/site_media/images/icons/deals_off_16.gif
large http://home.compete.com.edgesuite.net/site_media/images/icons/deals_on_53.gif
large http://home.compete.com.edgesuite.net/site_media/images/icons/deals_off_53.gif

Note: Please remember to use Compete branding when using the API. Also, be sure to read the API Terms of Use.


 


 


Wrappers

People have already begun implementing Compete Metrics for other systems and platforms, here's the ones we know about:



 


Compete API Branding Requirements

While the Compete API is provided to you at no-cost, we require that you adhere to our branding requirements, as follows:


Attribution


All input and output elements must be accompanied by clear “Compete.com” attribution.


Links


The following elements must be present and link to http://siteanalytics.compete.com using the standard linking format on your site.



  • Any displayed metrics must cite “Compete.com” as the source
  • Any displayed metrics must provide an active link to http://siteanalytics.compete.com

Graphs & Logos


If Compete data is used to create a graphical representation of Compete’s metrics a Compete logo needs to be present within or adjacent to the graphic. Please use an approved Compete logo (below). The logos can not be reduced in size. It’s up to the discretion of the publisher where to specifically place the logo within or adjacent to the graphic.




 


댓글 없음:

댓글 쓰기