API

Myrating.dk stiller et API til rådighed for alle interessenter af myratings data. For at få adgang til dette API, skal du kontakte administrator, med en beskrivelse af dit projekt. Hvis dit projekt godkendes, vil du modtage en API nøgle via mail, som du skal bruge når du trækker data fra myrating.dk

API'et understøter p.t. en enkelt metode, men ideen er løbende at udvide med flere metoder. De enkelte metoder er dokumenteret i de følgende afsnit.

API nøgle
Fælles for metoder på API'et er, at du skal sende din API nøgle med til kaldet. API nøglen modtager du, når dit projekt er blevet godkendt. API nøglen sendes med til hver metode som en url parameter. For eksempler, se eksempler på http kald under dokumentationen for hver enkelt metode.

Hent indhold
Dette er den mest basale metode på API'et, der henter informationer om et stykke indhold, samt alle anmeldelser af dette. For at kalde denne metode, laves et http request til den samme url på myrating.dk, som det der ønskes data for, efterfulgt af din API nøgle. Eksempel:

http://www.myrating.dk/indhold/100-erdinger_weissbier_dunkel?apikey=dinnøgle

Et kald til denne url vil returnere det html, der vises ved visning af Erdinger Weissbier Dunkel på myrating.dk. For at returnere JSON i stedet for HTML, modificeres Accept headeren i requestet til application/json.

Kaldet returnerer et JSON objekt, med følgende generelle felter:

Felt	Beskrivelse
status	'ok', hvis kaldet gik godt. 'error', hvis der opstod en fejl under kaldet.
errorCode	Indeholder en fejlkode der identificerer den opståede fejl. Denne attribut vil kun være tilstede, hvis kaldet fejlede. Fejlkoder: 1: Ukendt fejl. 2: Der er ikke angivet en API nøgle. 3: Den angivne API nøgle er ugyldig.
reason	Indeholder en tekstuel beskrivelse af den opståede kald. Denne attribut vil kun være tilstede, hvis kaldet fejlede.
data	Indeholder informationer om det forespurgte indhold samt anmeldelser. Se et eksempel nedenfor.

Følgende er et eksempel på et fejlende kald:

        {
            "status":"error",
            "reason":"invalid apikey"
        }
        

Følgende er et eksempel på et succesfuldt kald:

        {
            "status":"ok",
            "data":
            {
                "id":100,
                "name":"Erdinger Weissbier Dunkel",
                "description":"	Erdinger Dunkel er en mørk hvedeøl. Øllet er brygget på ristet hvede og bygmalt. Farven er mørkebrun og skummet cremet hvidt. Smagen er fyldig og frisk med toner af chokolade. Erdinger Dunkel bør skænkes med forsigtighed i et original Erdinger glas.",
                "link":"http://www.erdinger.de/en.html",
                "elements":
                [
                    {
                        "name":"Bryggeri",
                        "value":"Erdinger Weissbräu"
                    },
                    {
                        "name":"Alkoholprocent",
                        "value":"5,6"
                    }
                ],
                "createdBy":"ThomasArdal",
                "created":"02-08-2009 16:33:51",
                "rating":7.7,
                "numberOfVotes":3,
                "reviews":
                [
                    {
                        "id":515,
                        "text":"Nam nam!",
                        "rating":9,
                        "createdBy":"mhg",
                        "created":"08-03-2010 22:14:35"
                    },
                    {
                        "id":136,
                        "text":"Erdinger illustrerer, med denne dunkle øl, at de brygger noget af europas bedste øl. Skummet er flot og øllen er fuldt ud på højde med den lyse udgave i weissbier serien.",
                        "rating":8,
                        "createdBy":"ThomasArdal",
                        "created":"02-08-2009 16:34:29"
                    }
                ]
            }
        }

Smiley
Smiley api er flyttet til http://smileyapi.dk

Betingelser
myrating.dk er et gratis website. Det er som udgangspunkt ikke tilladt at bruge API'et til at benytte myratings data i kommercielle sammenhænge. Myratings brugere har automatisk ophavsret på alt det data de hver i sær opretter, mens myrating.dk har ophavrsret på det resterende indhold.