NAV

Innleiing

Velkomen skal du vere til Kittn API! Du kan bruke vårt API til å kalle våre Kittn endepunkt. Her kan du hente ut ymse informasjon om kattar, kattungar og ulike rasar frå vår database.

Her finn du kodedøme i Shell, Ruby, Python og Go! Du ser desse døma i det mørke feltet til høgre på skjermen – og du kan byta programmeringsspråk ved å klikke på menyen oppe til høgre.

Denne API-dokumentasjonen vart laga med DocuAPI, eit tema for den statiske nettstadsmakaren Hugo.

Autentisering

For å autentisere ein brukar, bruk denne koden:

package main

import "github.com/bep/kittn/auth"

func main() {
	api := auth.Authorize("meowmeowmeow")

	// Just to make it compile
	_ = api
}

require 'kittn'

api = Kittn::APIClient.authorize!('meowmeowmeow')

import kittn

api = kittn.authorize('meowmeowmeow')

# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
  -H "Authorization: meowmeowmeow"

const kittn = require('kittn');

let api = kittn.authorize('meowmeowmeow');

Gjer vel og erstatt meowmeowmeow med din eigen API-nøkkel.

Kittn tek i bruk API-nøklar for å gi tilgang til APIet. Du kan kan registrere deg for å få ein slik nøkkel på vår utviklarportal.

Kittn forventar at API-nøkkelen er med i alle API-førespurnader til serveren i ein header som ser slik ut:

Authorization: meowmeowmeow

Kattungar

Hent alle kattungane

package main

import "github.com/bep/kittn/auth"

func main() {
	api := auth.Authorize("meowmeowmeow")

	_ = api.GetKittens()
}

require 'kittn'

api = Kittn::APIClient.authorize!('meowmeowmeow')
api.kittens.get

import kittn

api = kittn.authorize('meowmeowmeow')
api.kittens.get()

curl "http://example.com/api/kittens"
  -H "Authorization: meowmeowmeow"

const kittn = require('kittn');

let api = kittn.authorize('meowmeowmeow');
let kittens = api.kittens.get();

Programmet over gir ein JSON-struktur som ser slik ut:

[
  {
    "id": 1,
    "name": "Fluffums",
    "breed": "calico",
    "fluffiness": 6,
    "cuteness": 7
  },
  {
    "id": 2,
    "name": "Max",
    "breed": "unknown",
    "fluffiness": 5,
    "cuteness": 10
  }
]

Dette endepunktet leverer alle kattungar.

HTTP-førespurnad

GET http://example.com/api/kittens

Query-parametrar

ParameterStandardverdiSkildring
include_catsfalseSet til true for å få alle kattar.
availabletrueSet til false for å ta med kattar som allereie er blitt adoptert vekk.

Hent éin kattunge

package main

import "github.com/bep/kittn/auth"

func main() {
	api := auth.Authorize("meowmeowmeow")

	_ = api.GetKitten(2)
}

require 'kittn'

api = Kittn::APIClient.authorize!('meowmeowmeow')
api.kittens.get(2)

import kittn

api = kittn.authorize('meowmeowmeow')
api.kittens.get(2)

curl "http://example.com/api/kittens/2"
  -H "Authorization: meowmeowmeow"

const kittn = require('kittn');

let api = kittn.authorize('meowmeowmeow');
let max = api.kittens.get(2);

Programmet over gir ein JSON-struktur som ser slik ut:

{
  "id": 2,
  "name": "Max",
  "breed": "unknown",
  "fluffiness": 5,
  "cuteness": 10
}

Dette endepunktet hentar ut éin spesifikk kattunge.

HTTP-førespurnad

GET http://example.com/kittens/<ID>

URL-parametrar

ParameterSkildring
IDIDen til kattungen du ynskjer å hente

Feil

Kittn-APIet tek i bruk følgjande feilkodar:

FeilkodeForklaring
400Bad Request – Din førespurnad har forbetringspotensiale
401Unauthorized – Feil API-nøkkel
403Forbidden – Denne kattungen er berre tilgjengeleg for administratorar
404Not Found – Denne kattungen vart ikkje funnen
405Method Not Allowed – Du prøvde å få tak i kattungen på ein snodig og ulovleg måte
406Not Acceptable – Du bad om eit format som ikkje er JSON
410Gone – Kattungen har rømt frå serveren.
418I’m a teapot
429Too Many Requests – Du spør om for mange kattungar, ta det med ro!
500Internal Server Error – Me har eit problem med serveren. Prøv igjen seinare.
503Service Unavailable – Me er nede for vedlikehald. Prøv igjen seinare.