Arendaja (API)

Otse API dokumentatsiooni: docs.paperlesspaper.de

Lisaks rakendusele pakub paperlesspaper ka API millega arendajad saavad integreerida individuaalseid rakendusi või olemasolevaid süsteeme.

API on praegu beetaversioonis. Seetõttu võivad tulevikus mõned asjad muutuda.

Kõik API ja muude võimaluste kohta leiad GitHub.

Esimesed sammud

API kasutamiseks pead sa:

• Kasutada kehtivat API-võtit API lõpp-punktidele päringute saatmiseks.
  Oma API-võtme leiad paperlesspaper-rakenduses.
• Ainult HTTPS-ühendused on lubatud. HTTP kaudu tehtud päringud suunatakse HTTP 301 ümbersuunamisega HTTPS-ile.
• API tagastab vastused JSON-formaadis. Vead kuvatakse JSON-kehas võtme error.

Kuidas luua tokeneid?

Sa saad API-võtmeid oma kasutaja seadetes genereerida.

Kus leian API dokumentatsiooni?

Sa leiad API dokumentatsiooni siin.

API-tokeni autentimine

Sa saad luua kohandatud API-tokeni paperlesspaperi rakenduses.
Autentimiseks lisa API-token x-api-key päisesse:

x-api-key: <Sinu-token>

• API-token peab olema 64-kohaline heksadesimaalne väärtus.
• Kui token on kehtiv, autentitakse päring vastava kasutaja nimel.

Autentimise veateated

• 401 Unauthorized: Token puudub, on kehtetu või aegunud.
• 403 Forbidden: Autentitud, kuid puudub õigus sellele lõpp-punktile.

Päringu- ja kasutuspiirangud

Juurdepääsupiirangud kehtivad iga API-võtme ja ajaperioodi kohta.
Piirang on 300 päringut minutis.
Ületamise korral saad HTTP-seisukoodi 429 Too Many Requests.

HTTP 503 vastus

HTTP 503 viga näitab API-juurdepääsus esinevat ootamatut koormuspiiki.
Server on tavaliselt viie minuti jooksul taas saadaval.
Kui häire püsib või esineb muid HTTP 5XX vigu, palun pöördu Tugi.

Deep linking rakendusse

Rakendus toetab sügavlinkimist, mis võimaldab kasutajatel teistest rakendustest või veebilehtedelt otse navigeerida rakenduse konkreetsetele funktsioonidele või lehtedele.

Näide

https://web.paperlesspaper.de/account

Lingib, kui rakendus on installitud, otse konto seadistustesse

https://web.paperlesspaper.de/account#no_universal_links

Hashiga #no_universal_linksaab sügavlinkimise keelata.