API-käyttöoikeus ja todennus

SPREEAI tarjoaa julkisen API-viittauksen hyväksytyille kumppanien työnkuluille: https://docs.spreeai.com/swagger/public/.

Käyttöoikeusmalli

API-laajuus, ympäristö, tunnistetiedot ja sallitut toiminnot sovitaan kumppanin käyttöönoton yhteydessä. Älä oleta, että sisäinen, kehitys- tai historiallinen päätepiste on saatavilla tuotannossa.

Valtakirjasäännöt

• Säilytä asiakassalaisuuksia ja käyttöoikeustunnuksia vain suojatussa palvelinpuolen salaisuuksien säilössä.
• Älä koskaan anna tunnistetietoja Gitiin, dokumentaatioon, ongelmien seurantatyökaluihin, kuvakaappauksiin tai esimerkkisovelluksiin.
• Älä koskaan lähetä tunnistetietoja analytiikka- tai lokitietoalustoille.
• Käytä ympäristökohtaisia ​​tunnistetietoja vain siinä ympäristössä, jota varten ne on myönnetty.
• Kierrätä tunnistetiedot välittömästi, jos ne tulevat vääriin käsiin.
• Poista tukipyyntöjen valtuutusotsikot ja -tunnukset.

Selain vs. palvelin

Web SDK käyttää kumppanin toimittamia selainmäärityksiä. Asiakassalaisuutta ei saa sisällyttää selaimeen.

Palvelinpuolen integraatioiden tulisi noudattaa nykyisen hyväksytyn API-viitteen todennusprosessia ja päätepistemääritelmiä. Kun tarvittavaa toimintoa ei ole, pyydä sitä Partner Engineeringin kautta sen sijaan, että rakentaisit dokumentoimattoman reitin.

Webhookit

Palvelimen push-webhookit eivät kuulu tällä hetkellä julkaistuun Web SDK:n dokumentaatioon. Vahvista mahdolliset webhook-vaatimukset ennen kuin suunnittelet niihin perustuvan riippuvuuden.

Ympäristötarkistuslista

• [ ] Ympäristön nimi on dokumentoitu.
• [ ] Perus-URL-osoite tuli hyväksytystä viitteestä tai käyttöönoton tiedoista.
• [ ] Kyseiseen ympäristöön myönnettiin tunnistetiedot.
• [ ] Salaisuudet tallennetaan palvelinpuolelle.
• [ ] Lokit poistavat tokeneita ja asiakaskuvia.
• [ ] Kirjoitusoperaatioille on sovittu aikakatkaisuista, uudelleenyrityksistä ja idempotenssitoiminnasta.
• [ ] Ei-tuotantotesti onnistuu ennen tuotantokäyttöoikeuden käyttöä.