Vi har APIer for arrangementer, deltagelse, fora, innlegg, kommentarer osv. Det er en noe spinkel versjon 1, men det meste av det man trenger burde være støttet. Vi regner med at vi sammen oppdager behovene for en videreutviklet V2 etterhvert som de melder seg gjennom bruk av APIet.

Tilgang

For å bruke APIene må du først gå hit og registrere en applikasjon. Dette kan alle gjøre. Når du har registrert applikasjonen får du en nøkkel og en hemmelighet, og informasjon om OAuth-endepunktene.

Begrensninger

• APIene er åpne for alle som er medlem på Underskog.

• Alle API-kall utføres på vegne av en bruker; det er altså ikke mulig å benytte APIene uten å gå via OAuth for å skaffe et token.

• Vi har foreløpig ikke satt noen begrensninger på bruk, men vi kommer til å følge med på loggene. Foreløpig er eneste regel at man må bruke sunn fornuft, og holde seg til medlemsavtalen.

Litt om OAuth

APIene er basert på OAuth. Vi støtter både OAuth 1.0 og 2.0. Brukeren må selv godkjenne at en ekstern applikasjon får tilgang til personlige data, og kan kun bruke APIet som sin egen bruker. Brukeren kan når som helst slette av denne godkjenningen inne under “Valg” og “Applikasjoner” på profilsiden sin.

Dokumentasjon

Dokumentasjonen på APIet finner du her.

Om du logger deg inn kan du bruke dokumentasjonssiden til å leke med APIet. (Dokumentasjonsgeneratoren har vi forresten lagt ut på Github om noen flere vil bruke det til sine prosjekter. Takk til @runeb som jobbet sammen med oss på dette.)

Eksempelkode

Vi har laget en bitteliten applikasjon i Ruby som bruker Sinatra og OmniAuth. Kildekoden er her.

Klientbiblioteker

For Ruby er dette klientbiblioteket under utvikling.

Om du ønsker å bygge en app som autentiserer med kan du bruke OmniAuth sammen med omniauth-underskog i f.eks. en Rails eller Sinatra-applikasjon.

For Python, se her.