API-åtkomst och autentisering

SPREEAI tillhandahåller en offentlig API-referens för godkända partnerarbetsflöden: https://docs.spreeai.com/swagger/public/.

Åtkomstmodell

API-omfattning, miljö, autentiseringsuppgifter och tillåtna åtgärder avtalas under partnerintroduktionen. Anta inte att en intern, utvecklings- eller historisk slutpunkt är tillgänglig i produktion.

Regler för autentiseringsuppgifter

• Lagra klienthemligheter och åtkomsttokens endast i ett säkert hemlighetsarkiv på serversidan.
• Spara aldrig inloggningsuppgifter till Git, dokumentation, ärendespårare, skärmdumpar eller exempelprogram.
• Skicka aldrig inloggningsuppgifter till analys- eller loggningsplattformar.
• Använd endast miljöspecifika autentiseringsuppgifter med den miljö som de utfärdades för.
• Rotera en autentiseringsuppgifter omedelbart om de exponeras.
• Ta bort auktoriseringsrubriker och tokens från supportförfrågningar.

Webbläsare kontra server

Web SDK använder partnerutfärdad webbläsarkonfiguration. En klienthemlighet får inte inkluderas i webbläsaren.

Serversidesintegrationer bör följa autentiseringsflödet och slutpunktsdefinitionerna i den aktuella godkända API-referensen. När en nödvändig åtgärd saknas, begär den via Partner Engineering istället för att konstruera en odokumenterad rutt.

Webhooks

Server-push webhooks ingår inte i den för närvarande publicerade dokumentationen för Web SDK. Bekräfta eventuella webhook-krav innan du utformar ett beroende för dem.

Miljöchecklista

• [ ] Miljönamnet är dokumenterat.
• [ ] Bas-URL:en kom från den godkända referensen eller onboarding-överlämningen.
• [ ] Autentiseringsuppgifter utfärdades för den miljön.
• [ ] Hemligheter lagras på serversidan.
• [ ] Loggar borttagning av tokens och kundbilder.
• [ ] Timeouts, återförsök och idempotensbeteende har överenskommits för skrivåtgärder.
• [ ] Ett icke-produktionstest lyckas innan produktionsåtkomst används.