Home

Scout-API

På den här wikin hittar man information om det API som applikationer (klienter) kan använda för att kommunicera med informationssystemet från /dev/scout.

I grunden finns en databas med scoutrelaterad information, ex. aktivitetsbeskrivningar. Informationen i denna databas görs tillgänglig via ett webbaserat API. Applikationer kan anropa detta API för att hämta och uppdatera informationen.

För att inte begränsa mängden möjliga applikationer (klienter) så ska API:et nås via http, sannolikt designat enligt en REST-arkitektur.

Olika användare har olika behov och olika applikationer har därför olika funktioner och finesser. Samtliga applikationer ska dock anropa samma API.

Exempel på saker som systemet skulle kunna ha stöd för i framtiden:

• Närvaro
• Terminsplanering
• Uppnådda mål (märken som tagits, utbildningar som genomförts osv.)

Operationer som kan anropas av API-klienter (Android-app, webbplats m.fl.)

Säkerhet gällande inloggning, behörighet, API-nycklar, övervakning mm.

Integration med externa system, såsom Aktivitetsbanken.

Versionshantering för olika versionen av API:et.

Bilagor och annan binär data (bilder, filmklipp osv.)

Länktips:

• Artiklar och tip som REST i allmänhet:
  • http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api
  • http://www.slideshare.net/stormpath/secure-your-rest-api-the-right-way
  • http://youtu.be/YCcAE2SCQ6k (Intro to REST)
  • http://apievangelist.com/
  • http://www.infoq.com/presentations/api-design-advice
  • http://apievangelist.com/2011/04/04/open-building-blocks-for-an-api/
  • http://apievangelist.com/2012/06/11/where-is-the-open-source-api-platform/
  • http://apievangelist.com/2011/05/21/open-source-api-billing-and-traffic-control/
  • http://www.mashup.se/nyheter/oppna-apier-presentation-fran-suniweb
• Verktyg och programmeringsspråk
  • Ruby och Rails
    • För nybörjare: Interaktiv snabbkurs på http://tryruby.org
    • För nybörjare: Interaktiv snabbkurs på http://railsforzombies.org
    • För nybörjare: Lång och välskriver introduktion på http://www.railstutorial.org/book
    • https://github.com/bbatsov/ruby-style-guide
    • http://railscasts.com/episodes/310-getting-started-with-rails?autoplay=true
    • http://railscasts.com/episodes/268-sass-basics?autoplay=true
    • http://railscasts.com/episodes/352-securing-an-api?autoplay=true
    • http://railscasts.com/episodes/350-rest-api-versioning?autoplay=true
  • Ramverket från 3Scale http://www.3scale.net/api-management/
    • https://github.com/3scale/3scale_ws_api_for_java
    • https://support.3scale.net/reference/libraries
    • http://youtu.be/7Gjdls00_sE (Up and Running with 3scale, Grape and Heroku in 10 minutes)
  • Java
    • http://youtu.be/ITmcAGvfcJI (Beautiful REST + JSON APIs with JAX-RS and Jersey)
    • https://stormpath.com/blog/beautiful-rest-json-apis-jax-rs-and-jersey/

Intressanta produkter när man ska skapa/administrera ett API:

• Mashery (http://youtu.be/aQ_isEq-pT8)
• 3Scale (http://youtu.be/7Gjdls00_sE)
• Apigee
• WSO2
• Nevatech Sentinet
• Apihany
• API Axle