Home

Binnenkort gaan we van start met de ontwikkeling van de Bierdopje API. Een API zorgt er voor dat je data van de site kunt te halen op een universele, effectieve en praktische manier. HTML parsen zal dan niet meer nodig zijn.

Kortom, als er iets in de layout van de site aangepast wordt, merk je hier in principe niets van omdat de API losstaat van de site.

Nu zijn we benieuwd naar welke functies er noodzakelijk zijn.
Zelf zit ik te denken aan een authenticatie methode via oAuth waarmee je in principe je Bierdopje useraccount in je eigen applicatie kan gebruiken.

In de toekomst gaan we eventueel over op een "beschrijfbare" API, waarmee je ook daadwerkelijk gegevens kunt gaan versturen naar de site.

Om de API te gebruiken zal je straks een APIkey moeten aanvragen. Deze key moet je vervolgens gebruiken om te communiceren met onze API.

Welke functies zijn er noodzakelijk? Beschrijf zo duidelijk mogelijk in het topic. Welke functie en wat moet het doen?

Let wel: het is niet gezegd dat we deze functies ook daadwerkelijk invoeren.

Geregistreerd: donderdag 22 november 2007 Berichten: 1400

Klinkt zooooo thetvdb.com/api (overigens schitterend idee!)

Heb hier nog wel een verzoek liggen... opvragen of een sub bestaat van S0XE0X
dus
api/SubNL.php?show=Family-Guy&season=0X&episode=0X
api/SubEN.php?show=Family-Guy&season=0X&episode=0X

Of je een show al gezien hebt...
api/ShowSeen.php?show=Family-Guy&season=0X&episode=0X

De mogelijkheden worden eindeloos \o/

Just4Fun

Een Api die kan zien of er nog cheese onion chips en amaretto cola in huis aanwezig is, zodat deze te linken is in mediaportal alvoren je van de bank afgaat en in de kast gaat lopen zoeken en je zoekt voor niets....

ben gelukkig niet verslaafd aan die stuff + series...

Dat zou dan eerder subs/nl/family.guy.s03e01.hdtv.blabla worden

Geregistreerd: woensdag 19 november 2008 Berichten: 568

idd, de mogelijkheden zijn eindeloos met zon api ! Goed werk sypher.

Men kan een offline based programma maken en vanaf de desktop zoeken naar je favoriete sub

Geregistreerd: woensdag 12 november 2008 Berichten: 12

djredmar:

api/SubNL.php?show=Family-Guy&season=0X&episode=0X
api/SubEN.php?show=Family-Guy&season=0X&episode=0X

Ik zou zowiezo i.p.v. the serienaam, een 'serie_id' gebruiken om fouten te voorkomen.

Je kunt dan wel een API maken waarmee je de serie_id op basis van de serienaam kunt opvragen. Dus meer zoals het bij thetvdb.com het geval is.

Voorbeeldje:

serie_id opvragen:
bierdopje.com/api/getserieid.php?seriename=Family Guy

episode_id opvragen:
bierdopje.com/api/getepisodeid.php?serieid=123&season=1&episode=2

subs opvragen:
bierdopje.com/api/getsubs.php?episodeid=4321&lang=nl

nzb opvragen:
bierdopje.com/api/getnzb.php?episodeid=4321

De functies die ik graag zou zien zijn:
- NZB-opvragen voor een episode als het kan met voorkeur voor Xvid/720p (weet niet of dat in de db bekend is...).
- Subs-opvragen voor een episode.
- 'Mijn shows' opvragen.
- Shows opvragen die je nog niet hebt gemarkeerd als 'verkregen' (zoals de myepisodes.com feeds hebben)

Geregistreerd: donderdag 22 november 2007 Berichten: 1400

@stereohead
zoek in bestaants naam op x264 (of 720p, maar x264 is bettrouwbaarder) of xvid, anders is het toch een waardeloze non-scene rip

en voor wat betreft je id suggestie.. SUPER, maar dan wel please de id's van thetvdb.com :-) deze kent mediaportal al, en kan je ze vrijwel direct linken

Geregistreerd: woensdag 12 november 2008 Berichten: 12

Dezelfde id's als die van tvdb.com zou handig zijn ja.

Bierdopje.com maakt toch gebruik van de thetvdb.com API's voor het vullen van hun eigen database? thetvdb.com FTW!

Geregistreerd: donderdag 22 november 2007 Berichten: 1400

neen, id's zijn van bierdopje zelf...

alle info komt er overigens wel vandaan

stereohead:

Dezelfde id's als die van tvdb.com zou handig zijn ja.

Bierdopje.com maakt toch gebruik van de thetvdb.com API's voor het vullen van hun eigen database? thetvdb.com FTW!

We kunnen helaas die ID's niet meer om gaan gooien. Er zit momenteel van alles (nzb, favorieten, subs) aan verbonden. Sowieso zijn we momenteel aan het denken om thetvdb te laten vallen, aangezien deze te traag is en het wat mist.

djredmar:

neen, id's zijn van bierdopje zelf...

alle info komt er overigens wel vandaan

Klopt.

Geregistreerd: woensdag 12 november 2008 Berichten: 12

Even een uitgebreid voorbeeld gemaakt van 'niet-verkregen' shows.

/api/getUnAquired.php?uid=123&key=ABCKEYABC

Waarbij:
uid = userid van een account
key = een string waarmee je je indentiteit bewijst (zie hieronder)

Dit zou het volgende als resultaat geven: ('[' en ']' moeten natuurlijk '<' en '> worden gebruikt, maar anders wordt weg-ge-parsed)

Code (php):

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
[response] [status]ok[/status] [userid]123[/userid] [unaquired] [episode] [id]134156623[/id] [serieid]61231[/serieid] [seriename]Lost[/seriename] [season]5[/season] [episode]8[/episode] [/episode] [episode] [id]134156725[/id] [serieid]61231[/serieid] [seriename]Lost[/seriename] [season]5[/season] [episode]9[/episode] [/episode] [episode] [id]134156141[/id] [serieid]61231[/serieid] [seriename]Lost[/seriename] [season]5[/season] [episode]10[/episode] [/episode] [/unaquired] [/response]

Heb zelf eens een authenticatie methode bedacht en gebruikt voor een online API. Die werkte als volgt:

Je vraagt eerst een challenge aan, dat is een willekeurige string. De challenge wordt op de server gekoppelt aan je account. Elke keer dat je een challenge aanvraagt wordt de challenge opnieuw gegenereerd.

De een challenge opvragen kan bv. zo:
/api/getChallenge.php?uid=123

Waarbij:
uid = userid van een account

Dit geeft dus de challenge terug, die op dit moment bij je account hoort.
Nu kun je met behulp van de challenge een key bepalen, op basis van de challenge, userid en wachtwoord:

$userid = 123;
$password = 'mylittlesecret';

// bepaal de hash van het wachtwoord, dit kan ook op een andere manier
// bijvoorbeeld: sha1($password . $email) of sha1($password) (maar dat is
// ietsje minder veilig)
$pwhash = sha1($userid . $password);

// de challenge die verkregen is met getChallenge.php
$challenge = 'aAbBcCdDeEfFgGHhIiKkLlMmNnOoPp';

// bepaal de key op basis van pwhash en challenge
$key = sha1($pwhash . $challenge);

Bij een API call waarbij authenticatie is vereist kunnen we nu de zojuist berekende key gebruiken.

Uiteraard zijn er meer manieren om je identiteit te bewijzgen, maar dit is er een van.

API's waarbij authenticatie is verijst lijkt mij:
- opvragen van de 'Mijn Series' lijst
- episode markeren als verkregen of bekeken
- lijst van niet-verkregen episodes opvragen
- lijst van niet-bekeken episodes opvragen
- alle andere dingen die persoonlijke informatie bevatten

Geregistreerd: woensdag 19 november 2008 Berichten: 568

Heel goed stereohead,

het lijkt erop dat je doel op een XML gen. Zelf vind ik XML te veel overhead hebben voor gebruik. Meer bytes genereren is meer dataverkeer.

Ik blijf erbij dat Formatted ASCII nog steeds het beste is om data te genereren.

Geregistreerd: woensdag 12 november 2008 Berichten: 12

Daar heb je gelijk in, maar dat kan verholpen worden door gzip commpressie te gebruiken.

Zie ook:
http://nl.php.net/ob_gzhandler

Geregistreerd: donderdag 22 november 2007 Berichten: 1400

en dat kost weer cpu load
.gz is geniaal, maar te zwaar op het eind.

xml heeft een paar mooie parsers die het uit kunnen lezen wat weer ASCII parsen scheelt.

ASCII == klein, maar je delimiter kan altijd problemen verzorgen. je kan natuurlijk per positie bepalen, is ansich veilig, maar mogelijk kom je data tekort waardoor het zou 'truncaten'

Geregistreerd: woensdag 12 november 2008 Berichten: 12

Ik denk eerlijk gezegd dat het dataverkeer dat een XML API oplevert wel meevalt. Vergeleken met de NBZ's en de images die bierdopje.com levert, valt een XML API in het niet.

Verder kan er ook nog JSON worden gebruikt. Dat heeft minder overhead.

Geregistreerd: zaterdag 12 januari 2008 Berichten: 1182

@djredmar: om het type rip te kennen, kan je best in het bestand zelf lezen. Daar kan je snel afleiden of het een 720p of HDTV of... is. Kijk even naar de source van MediaPortal. Daar gebeurt dat ook om te bepalen welke iconen ze in beeld brengen (720p, 40m, subs, ...).

@stereohead: volledig gelijk. JSON optimaliseert je XML verkeer.

@devixl: Er zijn een heel reeks redenen waarom XML een goed data formaat is, waaronder o.a. gekende structuur, mogelijkheid tot validate (xsd), eenvoudige transformatie (xslt), typisch SOAP protocol formaat, mainstream non-proprierty formatter/parser, ...
De performantie van XML over het net is trouwens een non-issue. De overhead op het net voor een roundtrip op die XML (kb's) is vele malen groter dan de XML zelf.
Daarbovenop is ASCII code-page gevoelig. Dit los je in XML op met de UTF notatie.

Tenslotte heb ik nog IMHO een advies rond de structuur van de data die de API gaat aanbieden.
De data is eigenlijk het belangrijkste deel van je service, nog belangrijker dan je functionaliteit. Data later veranderen is een stuk duurder (in tijd, inspanning en geld) dan je functie veranderen. Data in de message is ook 'exposed' en dat betekent een grote impact voor je consumers als je dat wijzigt. Dus is de structuur erg belangrijk.
Het best is dat het message formaat van de service zo dicht mogelijk aanleunt bij het logisch data model.

In het voorbeeld van stereohead zou dat dan kunnen zijn:

Code (php):

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
[color=blue]* identitity * user * ID * serie * id * name * season * type (main, special, ...) * year * nr * episode * id * name * nr * airdate[/color]

met herhaling van de structuur van serie als er verschillende series zijn opgevraagd.

Dit is maar een voorbeeld, but you know what I'm getting at

Geregistreerd: donderdag 22 november 2007 Berichten: 1400

waarom @ mij? kan me niet heugen dat ik dat vroeg?

Geregistreerd: zaterdag 12 januari 2008 Berichten: 1182

Ongeveer 10 berichten boven mijn post antwoord je op een vraag van stereohead.

Ik heb hier op ingepikt djredmar.

Geregistreerd: donderdag 22 november 2007 Berichten: 1400

ahh thnx

Geregistreerd: woensdag 12 november 2008 Berichten: 12

@xppx:
JSON kan gebruikt worden in plaats van XML, het optimaliseerd XML niet hoor.
Verder ben ik het eens dat de datastructuur belangrijk is, maar de manier die jij beschrijft, zorgt dat niet voor veel dataverkeer? Ik bedoel: er zit veel data in die je misschien niet gebruikt.

Geregistreerd: woensdag 19 november 2008 Berichten: 568

Ik zou wel graag een plugin willen maken voor mediaportal icm met bierdopje.
Dat zou echt te VET zijn...

Visual studio kennis heb ik aan boord.

Geregistreerd: donderdag 22 november 2007 Berichten: 1400

@devixl een fork van mp-tvseries? dat zou echt helemaal geweldig zijn

Geregistreerd: zaterdag 12 januari 2008 Berichten: 1182

stereohead:

...maar de manier die jij beschrijft, zorgt dat niet voor veel dataverkeer? Ik bedoel: er zit veel data in die je misschien niet gebruikt.

Het logische data model is er om de gegevens en hun onderlinge relaties op een gestructureerde manier te ordenen. Aan de andere kant kan de physische representatie van dat model worden aangepast aan de non-functionals, dwz dat je je message kan optimaliseren door enkel die entiteiten en attributen mee te sturen die noodzakelijk zijn voor je functionaliteit (van de service), maar wel in een vaste structuur.

Dat de top-entiteiten (show en seizoen) telkens worden meegestuurd is echt maar een overhead van enkele bytes met een onbeduidende performance penalty.

Geregistreerd: woensdag 19 november 2008 Berichten: 568

djredmar:

@devixl een fork van mp-tvseries? dat zou echt helemaal geweldig zijn

Idd !!

een droom die zou uitkomen...
Wat dacht je van Sub + nzb combi downloaden... Damn.. vanuit je luie stoel.

Geregistreerd: donderdag 22 november 2007 Berichten: 1400

correctie: vanuit me luie bank

nzb gebruik ik niet meer... nieuwe provider (35mbit!!! jeej!!)
maar sub idd wel, met duidelijk verschil tussen 720p vs xvid

Geregistreerd: zaterdag 19 april 2008 Berichten: 198

Sypher:

Sowieso zijn we momenteel aan het denken om thetvdb te laten vallen, aangezien deze te traag is en het wat mist.

Dat heb ik ook altijd al gevonden

. Misschien is het interessant om eens naar TVRage.com te kijken? De series en episodes die erop staan, zijn quasi altijd volledig. (Ik gebruik namelijk altijd TVRage.com om TheTVB aan te vullen.)

Hier kan je alvast informatie vinden over hun API. Ik weet wel niet hoe uitgebreid die is.

Home

BierdopjeV3 Alpha nu beschikbaar. Wil je helpen? Kijk dan hier

API: Welke functies zou je hier willen zien?