API-viite
Julkiset API-päätepisteet kehittäjille: lomakkeet, widget, tuotekonfiguraattori ja paljon muuta.
Tämä viite kuvaa ainoastaan todellisia, julkisesti käytettäviä JSON-päätepisteitä -- kunkin päätepisteen metodin, polun, todennustyypin, pakolliset parametrit, esimerkkipyynnön ja -vastauksen sekä dokumentoidut virhekoodit. Zentorilla ei ole yleistä kehittäjien API-avainjärjestelmää; reitistä riippuen pääsy tapahtuu joko ilman todennusta tai widgetin upotustunnisteella ja origin-tarkistuksella. Hallintapaneelin sisäiset reitit ja Master Admin -päätepisteet eivät tarkoituksella kuulu tähän julkiseen viitteeseen, koska niihin pääsee ainoastaan tavallisen kirjautumisistunnon kautta.
Jokaisessa päätepistemerkinnässä on live-testimerkintä, joka kertoo, perustuuko tieto rekisterin skeemaan, automaattiseen testiin vai todelliseen live-havaintoon -- pelkkää samankaltaisuutta toimivaan koodipolkuun ei pidetä täydellisenä näyttönä. Lisäksi teknisesti onnistunut kutsu vahvistaa aina vain kyseisen pyynnön käsittelyn, ei automaattisesti myöhempiä vaiheita, kuten sähköpostin toimitusta, maksun valmistumista tai onnistunutta SSO-kirjautumista.
Suojaus riippuu kyseisestä ryhmästä. Julkiset oikeudelliset, markkinointi- ja lomakepäätepisteet eivät vaadi hallintapaneelin istuntoa. Chat-widget sen sijaan käyttää `X-Widget-Token`-otsaketta ja sallittujen originien luetteloa. Hallintapaneeliin kirjautuminen palauttaa istunto-JWT:n, jonka voimassaoloaika on kaksitoista tuntia, ja refresh-tokenin, joka on voimassa seitsemän päivää. SSO-päätepisteet käyttävät omia kertakäyttökoodejaan ja callback-kulkujaan.
Lue jokainen päätepistesivu itsenäisenä sopimuksena. Ratkaisevia ovat HTTP-metodi, polku, pakolliset parametrit, tietotyypit, pyynnön runko, vastauksen rakenne, virhekoodit ja idempotenssi. Esimerkki näyttää mahdollisen muodon, mutta ei korvaa todellisen vastauksen tarkistamista. Konfiguraation tila, validoinnit, käyttöoikeudet ja ulkoiset palveluntarjoajat voivat muuttaa lopputulosta.
Vahvistettu koko alustan rate limit on 2 000 pyyntöä 15 minuutin aikana. Päätepistekohtaisia erillisiä rajoja ei ole dokumentoitu johdonmukaisesti. Siksi asiakasohjelmien ei pidä käyttää tarpeettoman tiheitä polling-silmukoita. Ei-idempotenteissa toiminnoissa automaattiset uudelleenyritykset voivat luoda päällekkäisiä tietueita tai viestejä.
Arkaluonteiset arvot eivät kuulu lokeihin. Niitä ovat salasanat, palautustunnisteet, vahvistuskoodit, widget-tunnisteet, istuntotunnukset ja todelliset henkilöön liittyvät esimerkkitiedot. Käytä dokumentaatiossa ja testeissä anonymisoituja arvoja. Live-testimerkintöjen on kuvattava todellinen näyttö oikein.