Utvecklare/API

Denna sida innehåller information till utvecklare hur man kan hämta annonsdata via Gokartmarknadens publika API.

1. Inledning

Detta dokument vänder sig, först och främst, till utvecklare eller annan teknisk kunnig person.

Dokumentet beskriver hur man ansluter sig och hämtar data från Gokartmarknadens öppna REST-API.

Via API:et kan följande data hämtas:

  • Hämta kategorier
  • Hämta län
  • Hämta annonstyper
  • Hämta annonser

2. Miljöer

API:et finns tillgängligt i två miljöer; test och produktion.

Test

https://test.gokartmarknaden.se/umbraco/Api/PublicApi

Produktion

https://www.gokartmarknaden.se/umbraco/Api/PublicApi

3. Metoder

3.1 Categories

Namn: GetCategories
Url: /Categories
Metod: Get

3.1.1 Svar (Response)

[

    {

        "Id": "0",

        "Name": "Chassin"

    },

]

3.1.2 Exempel

Returnerar alla publicerade kategorier som man kan filtrera på

https://test.gokartmarknaden.se/umbraco/Api/PublicApi/Categories

3.2 Counties

Namn: GetCounties
Url: /Counties
Metod: Get

3.2.1 Svar (Response)

[

    {

        "Id": "0",

        "Name": "Blekinge"

    },

]

3.2.2 Exempel

Returnerar alla publicerade län som man kan filtrera på

https://test.gokartmarknaden.se/umbraco/Api/PublicApi/Counties

3.3 AdvertTypes

Namn: GetAdvertTypes
Url: /AdvertTypes
Metod: Get

3.3.1 Svar (Response)

[

    {

        "Id": "0",

        "Name": "Säljes"

    },

    {

        "Id": "1",

        "Name": "Köpes"

    }

]

3.3.2 Exempel

Returnerar alla möjliga annonstyper som man kan filtrera på

https://test.gokartmarknaden.se/umbraco/Api/PublicApi/AdvertTypes

3.4 Adverts

Namn: GetAdverts
Url: /Adverts
Metod: Get

3.4.1 URL-parametrar

  • typeId [Integer] (Obligatorisk)
    Används för att filtrera på annonstyp (Säljes eller Köpes). Se 3.3 AdvertTypes.

  • catId [Integer]
    Används för att filtrera på kategori. Se 3.1 Categories.

  • countyId [Integer]
    Används för att filtrera på län. Se 3.2 Counties.

  • count [Integer]
    Används för att styra antalet annonser som skall returneras. Om inget anges så kommer max 20 st annonser att returneras.

3.4.2 Svar (Response)

[

        {

            "Id": "Unikt annons-id",

            "Created": "Publiceringsdatum",

            "CreatedFriendly": "Publiceringsdatum (Friendly)",

            "Heading": "Annonsrubrik",

            "Introduction": "Annonstext",

            "OriginalPrice": "Originalpris med kronor",

            "NewPrice": "Sänkt pris med kronor",

            "CurrentPrice": "Aktuellt pris med kronor",

            "Category": "Namn på kategori",

            "County": "Namn på län",

            "Url": "Url till annons",

            "ImageUrl": "Url till annonsbild"

        }

]

3.4.3 Exempel

Returnerar de fem senaste säljannonserna

https://test.gokartmarknaden.se/umbraco/Api/PublicApi/Adverts?typeId=1&count=5

Har du frågor kring API:et?

Skicka ett mejl till andreas@tripletta.se.