jonklo edited this page Jun 26, 2012 · 46 revisions

Dokus API

Dokus API gjør funksjonaliteten i Dokus tilgjengelig for eksterne applikasjoner og tjenester. API-et er basert på HTTP og prinsippene i REST, og enkelt å ta i bruk fra de fleste programmeringsspråk.

Tilgang til Dokus API

Alle Dokus-kontoer har tilgang til Dokus-API, uten ekstra kostnader.

Vi anbefaler å benytte en testkonto under utvikling mot Dokus API, som du enkelt oppretter helt gratis.

Alle operasjoner foregår i kontekst av en innlogget bruker, og brukere av API-et har tilgang til alle ressurser brukeren normalt har tilgang til i Dokus.

Autentisering gjøres med HTTP Basic authentication, og e-postadresse og passord for en Dokus-konto sendes med hver forespørsel i i HTTP-headeren Authorization, som støttes av de fleste HTTP-biblioteker. For å unngå at passord kan snappes opp av uvedkommende benyttes HTTPS til all kommunikasjon.

Hente og redigere ressurser

Ressurser hentes og redigeres ved å bruke vanlige HTTP GET og HTTP POST-operasjoner mot ressursenes URL.

API-klienter må sette HTTP-headeren Accept til application/json for å angi at data skal returneres som JSON. På samme måte må data som sendes til API-et også sendes som JSON og Content-Type settes til application/json.

Eksempel på GET-forespørsel med cURL:

curl -u bruker@dokus.no:passord -H 'Accept: application/json' https://dokus.no/products/

Eksempel på POST-forespørsel med cURL (merk at Content-Type-header må settes):

curl -u bruker@dokus.no:passord -H 'Accept: application/json' -H 'Content-Type: application/json' --data '{"name":"Testprodukt","price":"25.00","default_vat_class":"1"}' https://dokus.no/products/create/

Les en innføring i henting, redigering og sletting av data før du ser på spesifikke ressurser.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.