Búa til API-aðgang

Til að búa til API-aðgang þarftu fyrst að hafa samband við Vergo og láta okkur búa til svokallaðan kerfisnotanda fyrir þig.

Þegar kerfisnotandinn er tilbúinn skaltu fylgja þessum skrefum:

1. Farðu undir Stillingar > Notendur

2. Veldu kerfisnotandann.

3. Neðst á upplýsingasíðu kerfisnotandans geturðu ýtt á "Nýr API-aðgangur".

4. Veldu lýsingu og gildistíma.

5. Afritaðu bæði Client ID og Client secret. Athugaðu að Client secret verður ekki birt aftur, svo geymdu það á öruggum stað.

Með þessu Client ID og Client secret geturðu sótt aðgangslykil (access token) sem gerir þér kleift að kalla í Vergo API.

Athugaðu að með þessu access token ertu að vinna með réttindi kerfisnotandans. Þú getur stjórnað því hvaða réttindi/hlutverk kerfisnotandinn hefur undir Stillingar > Notendur og Stillingar > Hlutverk. Af öryggisástæðum mælum við alltaf með því að gefa kerfisnotanda lágmarksréttindi (minnstu mögulegu réttindi til að leysa verkefnið).

Hvernig sæki ég access token?

Þú sækir access token með því að senda HTTP POST-fyrirspurn á /oauth/token. Fyrirspurnin verður að vera form-encoded (application/x-www-form-urlencoded), ekki JSON, því þetta fylgir OAuth 2.0 staðlinum (client credentials grant).

Flest OAuth-forritunarsöfn senda þetta sjálfkrafa á réttu sniði.

Þú sendir þrjú gildi í bol (body) fyrirspurnarinnar:

grant_type: Verður alltaf að vera client_credentials
​client_id: Client ID-ið sem þú afritaðir
​client_secret: Client secret-ið sem þú afritaðir

Dæmi (curl):

curl -X POST https://api.vergo.is/oauth/token \

-H "Content-Type: application/x-www-form-urlencoded" \

-d "grant_type=client_credentials" \

-d "client_id=ÞITT_CLIENT_ID" \

-d "client_secret=ÞITT_CLIENT_SECRET"

Svar (þegar allt gengur upp): Þú færð JSON-svar með access token:

{

"access_token":"eyJhbGciOiJ...",

"token_type":"Bearer",

"expires_in":3600

}

Hvernig nota ég þetta access token þegar ég kalla í Vergo vefþjónstu?

Þegar þú kallar í vefþjónustu þarf þú að setja tokenið í Authorization header. Gildið á að vera:
Bearer {þitt_access_token}

Athugaðu að þú þarft líka að tilgreina hvaða fyrirtæki þú ert að reyna að tengjast. Þú þarft að setja auðkennið á fyrirtækinu þínu í Vtenantid header. Auðkennið getur þú séð í vefslóðinni í vafranum þínum þegar þú ert inni á Vergo síðunni:

Hvaða vefþjónustur eru í boði?

Til að fá upplýsingar um vefþjónustur hafðu þá samband við Vergo.