Regla Rest þjónusta – Hjálp

REST þjónusta reglu er einföld vefþjónusta sem skilar færslum fyrirtækis á JSON formi.

Hér að neðan eru ítarlegar leiðbeiningar hvernig maður tengist þjónustunni og hvaða endapunktar eru í boði.

Til að nota vefþjónustuna þarf fyrst að stofna nýjan lykil. Þegar nýr lykill hefur verið stofnaður er hægt að nota vefþjónustuna.

Hvernig stofnar maður nýjan lykil?

Það fyrsta sem þarf að gera svo hægt sé að tengjast vefþjónustunni er að stofna API lykil fyrir fyrirtækið.

Það er gert í vefkerfi reglu. Notandi skráir sig inn í Reglu með sínu notendanafni og lykilorði.

Eftir að notandi er innskráður skal fara með músarbendilinn yfir Stjórnun. Þaðan skal velja Fyrirtækið.

Þegar komið er inn á síðuna Fyrirtækið skal smella á takkann sem býr til nýjan api lykil.´.

Eftir að smellt hefur verið á takkann. Birtist nýr api lykill.

Athugið að mikilvægt er að þið afritið lykilinn og geymið á öruggum stað.

Enginn nema þú sem bjóst til lykilinn ert með aðgang að honum. Við hjá Reglu getum ekki grafið upp lykilinn ykkar ef þið tínið honum.

Þá er eina í stöðunni að búa til nýjan lykil með að ýta á Búa til nýjan lykil takkann.

Hvaða endapunktar eru í boði?

Eins og er, þá er vefþjónustan minimalísk, en það verður bætt við fleiri endapunktum í nánustu framtíð.

Eftirfarandi sex endapunktar eru í boði. Allir endapunktar eru GET endapunktar

2. Transactions

4. Customers

5. Products

6. Search Invoices

Hvernig auðkenni ég mig?

Þú auðkennir þig með apa lyklinum sem þú bjóst til í skrefi eitt hér fyrir ofan.

Lykilinn er settur inn í header sem X-API-KEY

Hér að ofan er dæmi um hvernig maður auðkennir sig. Lykilinn er settur í header X-API-KEY = LYKILL

Tengdar greinar