Dopingkollen.se - api

Dopingkollen har för närvarande två stycken API:er. Ett sök-api samt ett api för att lägga till/uppdatera produkter. Transporten sköts över http och datan kommer i JSON-format.

Generella felkoder:

Felkod

Meddelande

0

OK

1

Missing parameter

2

Not valid JSON format

3

Parsing error

10

Unknown error

 

Sök efter produkt

URL: http://dopingkollen.se/api/search/product.json?product=PRODUCTNAME

Data för inga produkter:

{
    "code":0,
    "message":"OK",
    "info":"No product found",
    "result":null
}

Data för hittade produkter:

{
    "code":0,
    "message":"OK",
    "result":[
        {"name":"productname",
          "image":"imageurl",
          "ingredients":[
              {
                  "name":"Ingredient1"
              },
             {
                 "name":"Ingredient2"
             }
         ]
       }
     ],
     "status": "OK"
}

Notis: status meddelar ifall produkten hade ämne i sig som inte är godkända enligt rf’s regler.

Lägg till produkt

URL: http://dopingkollen.se/api/add/product.json
Metod: POST

För att lägga till en produkt ange adressen ovan. http metoden måste vara satt till POST, annars läses inga parametrar in.

Parametrar som krävs:

·         name

·         ingredients

Extraparametrar:

·         barcode

Data skickas även den som direkt json till api:et.

Exempel:

{
  name”: ”Testprodukt”,
  ingredients”: [{”name”: ”ingrediens”}, {”name”: ”ingrediens2}]

}

Svar tillbaka, om inget fel:

{
     ”code”: 0,
    ”message”: ”OK”,
    ”info”: ”Product added”
}

 

Övrigt info:

Alla felmeddelanden (och nästan alla anrop) kommer med en parameter som heter “info”, där man kan se lite mer detaljerade felmeddelande, medans man implenmenterar apit!