Menar du...


  • Kategorier för din sökning

  • Inget resultat

    Vendre REST API

    Vårt REST API är till för dig som vill bygga egna funktioner från din server. All data via API:et följer JSON-standard.
    Artikelnummer: 56080000

    Komma igång

    Först så behöver du säkerhetsställa att du har tillgång till vårt API i din butik vilket du kan kontrollera under Appar & Integration > API. Saknar du tillgång till vårt API går det jättebra att höra av sig till support@vendre.se så aktiverar vi tjänsten åt dig.
    När API-tjänsten är aktiverad i din butik så är det första du behöver göra att skapa en användare i Vendres admin. Vi rekommenderar dig att skapa en helt ny användare för att det ska bli tydligt i butiken vilken användare som används till API-tjänsten. 

    Skapa en användare och få tillgång till API-nyckeln

    För att skapa en ny användare så går du in på Inställningar > Administratörer. Döp gärna användaren till den app / det bolag som ni avser att integrera med. Det möjliggör att ni ser historiken när API användaren genomför ändringar i er butik.

    När du har skapat en ny användare finns det en hemlig nyckel genererad. Det är din API access key som ger dig åtkomst till all data i din butik via vårt API.

    Tips! Lägg in support mejladressen till aktuell integrationspartner (tex support@sharespine.com) på användaren. Vi brukar inte skicka iväg något lösenord (dvs. inaktivera alternativet att mejla lösenordet till användaren), det räcker att du lägger in ett lösenord.

    Anrop

    URL:en som används vid anrop till API:et består av webbadressen till din butik med följt av /API/1/.
    Vill du t.ex. hämta alla produkter som existerar i butiken ser URL:en ut såhär: https://butiksnamn.se/API/1/products.

    API-nyckeln definieras med key X-Authorization i header.

    Till höger så kan du se ett exempel på ett CURL-anrop med syfte att uppdatera en produkt.

    curl -X PUT -H 'X-Authorization: UWEQdLv-DQNpabDDSJB4AFLojPbH0ohp0B' -d '{"quantity":1.23,"weight":2.34,"price":3.45}' https://demo.testavendre.se/API/1/products/10961

    Matcha poster utan att skicka in interna id:s

    I flera anrop så behöver/kan man inte söka fram poster via Vendres interna id:s. För dessa så finns det istället ett fält som heter match och som skickas in i payloaden/bodyn (även för GET-anropen). I detta json-objekt skickar man in det matchningsfält som används för anropet ifråga (kan vara t.ex. externt id).

    Match-logiken finns framför allt i nyskapade anrop som generellt är i singularis (d.v.s. /product istället för /products/{id}) men även vissa andra anrop har fått stöd för match på olika ställen. Se exempel på match-fält nedan (för specifik info om vad som ska skickas in, se swaggern för vårt API längre ned):

    {
        "match": {
            "external_id": "ABC123"
        }
    }

    API-dokumentation

    I swagger dokumentationen nedanför så har vi samlat alla våra endpoints som finns att tillgå från plattformen. Klicka på den endpoint som du är intresserad av att veta mer om för att ta reda på vilken data som returneras samt vilka parametrar som du kan använda. 

    OBS! Swaggern utgår från vår standard-butik. Den kan sakna både anrop och parametrar som är rättighetsstyrda. För fullständig Swagger gå in i administrationen i din butik  www.butik.se/Admin/api/. 

    Dokumentationsversioner

    Swagger 1.2 (API/resources) samt OpenAPI 3.03 (API/openapi-3.0.json).