Arendaja (API)
Integreeri paperlesspaper otse oma rakendustesse.
Lisaks rakendusele pakub paperlesspaper ka API, millega arendajad saavad integreerida individuaalseid rakendusi või olemasolevaid süsteeme.
Esimesed sammud
API kasutamiseks peate:
- Kasutama kehtivat API-võtit, et saata päringuid API lõpp-punktidele.
Oma API-võtme saad paperlesspaperi rakenduses. - Lubatud on ainult HTTPS-ühendused. Päringud HTTP kaudu suunatakse HTTP 301-ümbersuunamisega HTTPS-ile.
- API tagastab vastused JSON-formaadis. Veateated ilmuvad JSON-kehas võtme all
error.
Kuidas luua märke?
Saate API-võtmeid luua oma kasutaja seadetes.
Kust leida API dokumentatsiooni?
Dokumentatsiooni leiate siit.
API-tunnuse autentimine
Saate luua kohandatud API-tunnuse rakenduses paperlesspaper või oma administraatori kaudu.
Autentimiseks lisage API-tunnus Authorization-päisesse kui Bearer-tunnus:
Authorization: Bearer <Teie-tunnus>
- API-tunnus peab olema 64-kohaline heksadetsimaalne väärtus.
- Kui tunnus on kehtiv, autentitakse päring seotud kasutaja nimel.
Autentimise veateated
401 Unauthorized: Tunnus puudub, on kehtetu või aegunud.403 Forbidden: Autentitud, kuid lõpp-punkti jaoks pole luba.
Kasutus- ja kiiruspiirangud
Juurdepääsupiirangud kehtivad iga API-võtme ja ajavahemiku kohta.
Piirang on 300 päringut minutis.
Lisaks võivad olenevalt paketist kehtida täiendavad kasutuspiirangud.
Piirangu ületamisel saate HTTP-staatuse 429 Too Many Requests.
HTTP 503 vastus
HTTP-503 viga näitab ootamatut koormuse kasvu API-le juurdepääsul.
Server on tavaliselt viie minuti jooksul taas saadaval.
Püsiva häire või muude HTTP 5XX vigade korral võtke ühendust toega.
Sügavlinkimine rakendusse
Rakendus toetab sügavlinkimist, mis võimaldab kasutajatel teistest rakendustest või veebilehtedelt otse rakenduse teatud funktsioonide või lehtede juurde navigeerida.
Näide
https://web.wirewire.de/account
Kui rakendus on installitud, viib link otse konto seadistustesse
https://web.wirewire.de/account#no_universal_links
Hashiga #no_universal_link saab sügavlinkimise deaktiveerida.