Acces și autentificare API

SPREEAI oferă o referință API publică pentru fluxurile de lucru ale partenerilor aprobați: https://docs.spreeai.com/swagger/public/.

Model de acces

Domeniul de aplicare, mediul, acreditările și operațiunile permise ale API-ului sunt convenite în timpul integrării partenerilor. Nu presupuneți că un endpoint intern, de dezvoltare sau istoric este disponibil în producție.

Reguli privind acreditările

Stocați secretele clientului și token-urile de acces doar într-un depozit de secrete securizat pe server.
Nu transferați niciodată acreditări către Git, documentație, instrumente de urmărire a problemelor, capturi de ecran sau aplicații exemplu.
Nu trimiteți niciodată acreditări către platforme de analiză sau înregistrare.
Folosiți acreditările specifice mediului doar cu mediul pentru care au fost emise.
Rotiți imediat o acreditare dacă este expusă.
Redactați anteturile și token-urile de autorizare din solicitările de asistență.

Browser versus server

SDK-ul web utilizează o configurație de browser emisă de partener. Nu trebuie inclusă o secțiune secretă a clientului în browser.

Integrările pe partea de server ar trebui să respecte fluxul de autentificare și definițiile endpoint-urilor din referința API aprobată curentă. Atunci când o operațiune necesară lipsește, solicitați-o prin intermediul Partner Engineering în loc să construiți o rută nedocumentată.

Webhook-uri

Webhook-urile server-push nu fac parte din documentația Web SDK publicată în prezent. Confirmați orice cerință de webhook înainte de a proiecta o dependență pe aceasta.

Listă de verificare pentru mediu

[ ] Numele mediului este documentat.
[ ] Adresa URL de bază provine din referința aprobată sau din transferul inițial.
[ ] Au fost emise acreditări pentru acel mediu.
[ ] Secretele sunt stocate pe server.
[ ] Jurnalele elimină token-uri și imagini ale clienților.
[ ] Au fost convenite termene de expirare, reîncercări și comportamentul idempotenței pentru operațiunile de scriere.
[ ] Un test care nu este în producție are succes înainte de utilizarea accesului de producție.