ratebeerapi (1)

Upload: rajesh-garg

Post on 07-Apr-2018

213 views

Category:

Documents


0 download

TRANSCRIPT

  • 8/6/2019 ratebeerapi (1)

    1/11

    RateBeer API

    RateBeer allows for JSON interaction for web developers looking to implement dynamic content from

    RateBeer or mobile applications that allow RateBeer users to better interact with the site via mobile

    device.

    More info on JSON is available here.

    http://www.json.org/

    Please Do

    Get a developer key, it's now required

    Share your creations with us. We can help promote them.

    Provide feedback, especially if you've found a glitch

    Please Don't

    Hammer the site with repeating, recursive or otherwise demanding requests

    Build a remote database of our copyrighted content

    Share your developer keys

    Beers

    I've created an updating list of beers with beer name, BeerID and searchable field here:

    http://www.ratebeer.com/documents/downloads/beers.zip

    It's recreated automatically every Saturday morning.

    Below are the scripts available with instructions for use. If you have any questions or would like a

    http://www.json.org/http://www.ratebeer.com/documents/downloads/beers.ziphttp://www.json.org/http://www.ratebeer.com/documents/downloads/beers.zip
  • 8/6/2019 ratebeerapi (1)

    2/11

    custom script, please ask!

    Send me an email [email protected].

    ===================================================================

    User remote login

    http://www.ratebeer.com/Signin_m.asp

    receives via post...

    username = user name

    pwd = passwordsaveinfo = whether to assign a cookie to the browser (bit)

    redirect = redirection URL at your site to process post log in

    script will return the user to the above redirect script with the following querystring info

    uid = RateBeer User ID

    You can then store the user ID in a cookie or session variable to use with subsequent query requests.

    =================================================================

    Saving A Beer Ratinghttp://www.ratebeer.com/m/m_saverating.asp

    post the following...

    BeerID = bid

    Aroma = Aroma

    Appearance = AppearanceTaste = Taste

    Mouthfeel = Mouthfeel

    Overall = Overall

    UserID is verified via session variable

    ---------------------------------------------------------------------------------------------------------------

    http://www.ratebeer.com/Signin_m.asphttp://www.ratebeer.com/Signin_m.asphttp://www.ratebeer.com/m/m_saverating.asphttp://www.ratebeer.com/Signin_m.asphttp://www.ratebeer.com/m/m_saverating.asp
  • 8/6/2019 ratebeerapi (1)

    3/11

    UPC Search

    /json/upc.asp

    Returns top two matches of UPC to Beer.

    Example:

    http://www.ratebeer.com/json/upc.asp?upc=636251770128

    upc = UPC

    ---------

    Best Beers By Country

    /json/bcc.asp

    Shows best beers by country. Optional userid shows best you haven't had.

    u = userid (optional)

    c = country id

    -----------------

    Beers Available At Place

    /json/beershere.asp

    get beers at places by place id..

    pid = place id

    -----------------

    http://www.ratebeer.com/json/upc.asp?upc=636251770128http://www.ratebeer.com/json/upc.asp?upc=636251770128http://www.ratebeer.com/json/upc.asp?upc=636251770128http://www.ratebeer.com/json/upc.asp?upc=636251770128http://www.ratebeer.com/json/upc.asp?upc=636251770128http://www.ratebeer.com/json/upc.asp?upc=636251770128
  • 8/6/2019 ratebeerapi (1)

    4/11

    PlaceSearch

    /json/psstring.asp

    search for places by string. Helps if you send western characters.

    s = place search string

    -----------------

    Get Top Users

    /json/topusers.asp

    Returns the top users

    p = page number

    r = records per page (30 max)

    ----------------

    Get Top Beers

    /json/tb.asp

    Top 50 worldwideTop 50 beers by season

    Top 50 beers by country

    m = mode. "season", "country" or "top50"

    u = userID, sent so that a user knows if they've had it or not (for top50 and country only)

    s= sort type (for top50 only)

    season = season integer (1-4 for winter through fall for season only)c = countryID (see below bottom for country values for country only)

    ----------------

    Beer images are available (when available) from /beerimages/[beerid].jpg

    ----------------Get Ratings (Reviews) For A Beer

    /json/gr.asp

    bid = BeerID

    uid = UserID (if you wanted to show a rating from a single user)s = sort (optional, defaults to most recent)

    p = page number (this is optional and designated the page of ratings you'd like to view. 10 per page.)

  • 8/6/2019 ratebeerapi (1)

    5/11

    ----------------

    Get Recent Raves

    /json/raves.asp

    no parameters

    ----------------

    Get Recent Raves

    /json/ratpag.asp

    r = number of records to return (optional, max is 30)

    no other parameters

    ----------------

    New Beers

    http://ratebeer.com/json/nb.asp?d=10/01/2009&p=1p = Page Number, integer

    d = date (format is Microsoft, American)

    Beer search by beerid

    http://ratebeer.com/json/bff.asp?bd=12

    Beer availability search by beerid

    http://ratebeer.com/json/where.asp?bd=12

    Beer search by string

    http://ratebeer.com/json/bff.asp?bn=francisco

    Advanced beer search by stringhttp://ratebeer.com/json/bff.asp?b=franc&u=userid

    u=UserID

    Place info by id

    http://ratebeer.com/json/pss.asp?pid=101

    Brewer id search

    http://ratebeer.com/json/nb.asp?d=10/01/2009&p=1http://ratebeer.com/json/bff.asp?bd=12http://ratebeer.com/json/where.asp?bd=12http://ratebeer.com/json/bff.asp?bn=franciscohttp://ratebeer.com/json/bff.asp?bn=franciscohttp://ratebeer.com/json/pss.asp?pid=101http://ratebeer.com/json/nb.asp?d=10/01/2009&p=1http://ratebeer.com/json/bff.asp?bd=12http://ratebeer.com/json/where.asp?bd=12http://ratebeer.com/json/bff.asp?bn=franciscohttp://ratebeer.com/json/bff.asp?bn=franciscohttp://ratebeer.com/json/pss.asp?pid=101
  • 8/6/2019 ratebeerapi (1)

    6/11

    http://ratebeer.com/json/bss.asp?bd=11

    Brewer search by namehttp://ratebeer.com/json/bss.asp?bn=anchor

    Beer Places available by Geo

    http://ratebeer.com/json/beerme.asp?mi=15&ci=Chicago

    Miles Radius = miCity = ci

    Latitude = la

    Longitude = lo

    Get My Messageshttp://ratebeer.com/json/msg.asp?u=12&max=15

    u= userid

    max = max number of messages (< 100)

    Show all the Beers by a Brewer

    http://ratebeer.com/json/bw.asp

    UserID = u (optional)

    BrewerID = bSort = s (optional)

    Show me Rate Counts of a User (returns place ratings and beer rating counts)

    http://ratebeer.com/json/rc.asp?uid=954UserID = uid

    Show me Rate Counts of a Place

    http://ratebeer.com/json/rc.asp?pid=110

    PlaceID = pid

    Show me Rate Counts of a Beerhttp://ratebeer.com/json/rc.asp?bid=54

    BeerID = bid

    Get Brewers list for offline searching

    http://ratebeer.com/json/bss.asp?bd=11http://ratebeer.com/json/bss.asp?bn=anchorhttp://ratebeer.com/json/bss.asp?bn=anchorhttp://ratebeer.com/json/bss.asp?bn=anchorhttp://ratebeer.com/json/bss.asp?bn=anchorhttp://ratebeer.com/json/rc.asp?uid=954http://ratebeer.com/json/rc.asp?pid=110http://ratebeer.com/json/rc.asp?bid=54http://ratebeer.com/json/bss.asp?bd=11http://ratebeer.com/json/bss.asp?bn=anchorhttp://ratebeer.com/json/bss.asp?bn=anchorhttp://ratebeer.com/json/bss.asp?bn=anchorhttp://ratebeer.com/json/bss.asp?bn=anchorhttp://ratebeer.com/json/rc.asp?uid=954http://ratebeer.com/json/rc.asp?pid=110http://ratebeer.com/json/rc.asp?bid=54
  • 8/6/2019 ratebeerapi (1)

    7/11

    http://www.ratebeer.com/documents/downloads/brewers03032010.csv

    List Of Country Codes

    CanadaEngland

    United States

    -------------

    Afghanistan

    Albania

    Algeria

    American Samoa

    Andorra

    Angola

    Anguilla

    Antigua & Barbuda

    Argentina

    Armenia

    Aruba

    Ascension Island

    Australia

    Austria

    Azerbaijan

    Bahamas

    Bahrain

    Bangladesh

    Barbados

    BelarusBelgium

    Belize

    Benin

    Bermuda

    Bhutan

    Bolivia

    Bosnia

    Botswana

    Brazil

    British Virgin Islands

    Brunei

    Bulgaria

    Burkina Faso

    Burundi

    Cambodia

    Cameroon

    Cape Verde Islands

    Cayman Islands

    Central African Republic

    Ceuta

    Chad

  • 8/6/2019 ratebeerapi (1)

    8/11

    Chile

    China

    Christmas Island

    Cocos-Keeling Islands

    Colombia

    Comoros

    Congo

    Cook IslandsCosta Rica

    Croatia

    Cuba

    Cyprus

    Czech Republic

    Dem Rep of Congo

    Denmark

    Diego Garcia

    Djibouti

    Dominica

    Dominican Republic

    East TimorEcuador

    Egypt

    El Salvador

    England

    Equatorial Guinea

    Eritrea

    Estonia

    Ethiopia

    Falkland Islands

    Faroe Islands

    Fiji Islands

    Finland

    France

    French Guiana

    French Polynesia

    Gabon

    Gambia

    Georgia

    Germany

    Ghana

    Gibraltar

    Greece

    GreenlandGrenada

    Guadeloupe

    Guam

    Guatemala

    Guernsey

    Guinea

    Guinea-Bissau

    Guyana

    Haiti

  • 8/6/2019 ratebeerapi (1)

    9/11

    Honduras

    Hong Kong

    Hungary

    Iceland

    India

    Indonesia

    Iran

    IraqIreland

    Isle of Man

    Israel

    Italy

    Ivory Coast

    Jamaica

    Japan

    Jersey

    Jordan

    Kazakhstan

    Kenya

    Kiribati RepublicKosovo

    Kuwait

    Kyrgyz Republic

    Laos

    Latvia

    Lebanon

    Lesotho

    Liberia

    Libya

    Liechtenstein

    Lithuania

    LuxembourgMacau

    Macedonia

    Madagascar

    Malawi

    Malaysia

    Maldives

    Mali

    Malta

    Marshall Islands

    Martinique

    MauritiusMayotte Island

    Mexico

    Micronesia

    Moldova

    Monaco

    Mongolia

    Monserrat

    Montenegro

    Morocco

  • 8/6/2019 ratebeerapi (1)

    10/11

    Mozambique

    Myanmar

    Namibia

    Nauru

    Nepal

    Netherlands

    Netherlands Antilles

    New Caledonia

    New Zealand

    Nicaragua

    Niger

    Nigeria

    Niue

    Norfolk Island

    North Korea

    Northern Ireland

    Northern Marianas

    Norway

    Oman

    PakistanPalau

    Palestine

    Panama

    Papua New Guinea

    Paraguay

    Peru

    Philippines

    Poland

    Portugal

    Puerto Rico

    Qatar

    RunionRomania

    Russia

    Rwanda

    Saipan Island

    Samoa

    San Marino

    So Tom & Principe

    Saudi Arabia

    Scotland

    Senegal Republic

    Serbia

    Seychelles

    Sierra Leone

    Singapore

    Slovak Republic

    Slovenia

    Solomon Islands

    Somalia

    South Africa

    South Korea

  • 8/6/2019 ratebeerapi (1)

    11/11

    Spain

    Sri Lanka

    St Helena

    St Kitts

    St Lucia

    St Vincent & The Grenadines

    Sudan

    Suriname

    Swaziland

    Sweden

    Switzerland

    Syria

    Taiwan

    Tajikistan

    Tanzania

    Thailand

    Tibet

    Tinian Island

    Togo

    TokelauTonga

    Trinidad & Tobago

    Tunisia

    Turkey

    Turkmenistan

    Turks and Caicos Islands

    Tuvalu

    Uganda

    Ukraine

    United Arab Emirates

    United States Virgin Islands

    UruguayUzbekistan

    Vanuatu

    Vatican City

    Venezuela

    Vietnam

    Wales

    Yemen

    Zambia

    Zimbabwe