Versions Compared

Version Old Version 2 New Version Current
Changes made by

Kaupo Karuse

Kaupo Karuse

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

TL;DR

  • Rest API, HTTPS, Basic Auth.

  • Väljundiks XML või JSON (default: XML)

  • GET päringutega töötavad filter, sort, range, updates_after ja vastuses soovitud väljade loetelu.

  • POST ja PATCH meetodi andmeformaat on x-www-form-urlencoded

  • Kasutatavad kõik registrid, mis ka Standard Booksi klientprogrammis

  • Rest API kasutaja allub standardsele Kasutajagrupile.

  • Attachmente võib GETiga Standard Booksist küsida, kuid neid ei saa lisada.

Seadistamine Standard Booksis

Alates versioonist 8.0 saab HansaWorldi toodetes kasutada Web API päringuid andmete pärimiseks ja kirjutamiseks.

Eeltingimused

·        Kliendil Kliendil peab olemas olema moodul:

  • Standard ERP puhul - "Veebipood"

...

On rangelt soovitatav kasutada MyStandardis valideeritud emaili sisse logimiseks. Uue isiku ja sealhulgas valideerimise juhend on siin: https://www.excellent.ee/kasutajatugi/kuidas-lisada-uut-kasutajat/

Kasutajagrupid Kasutajagrupil REST API

...

Valikulised võimalused

...

Märgitud peavad olema järgnevad valikud:·        

  • Web Rest API

...

  • Allow Basic HTTP Authentication

Valikulised Võimalused

...

Kasutamine

...

Andmed päritakse URLiga ehk inimkeeli - klient ütleb Hansa serverile aadressi, mille põhjal Hansa server väljastab vastava info.

Element

Kirjeldus

Näide

Protokoll

kasutatakse kas HTTP või HTTPS protokolli. HTTPS on turvaline, HTTP on peaagu avalik

https

IP

Serveri IP aadress

mars.excellent.ee

Port

Serveri veebi port

4455

Ettevõte

Ettevõtte kood andmebaasis

1

Register

Registri nimi, mida pärime

ivvc

Filter

Väli, mille alusel päringut filtreerida

filter.Custcode=

Väljad

Väljad, mis tagastatakse päringuga. (Ilma antud elemendita tagastatakse kõik väljad)

fields=SerNr,OKFlag,

header

HTTP päringu headeris määratakse, mis formaadis andmeid saadetakse, mis formaadis palutakse vastust ning ka Basic Auth informatsioon.

“Accept” väärtust on vaja täpsustada vaid siis, kui soovitakse JSONit. Default on XML.

Code Block
--header 'Content-Type: application/x-www-form-urlencoded;charset=utf-8'
--header 'Accept: application/json'
--header 'Authorization: XXX=='

 

Eraldajad:

  • ? - Sisestatakse peale Registri defineerimist, et kirjeldada filtreid.

  • & - Sisestatakse erineva tüübiga filtreeringute vahele.

...