API-toegang en authenticatie
SPREEAI biedt een openbare API-referentie voor goedgekeurde partnerworkflows: https://docs.spreeai.com/swagger/public/.
Toegangsmodel
API-bereik, omgeving, inloggegevens en toegestane bewerkingen worden overeengekomen tijdens de onboarding van partners. Ga er niet van uit dat er een intern, ontwikkelings- of historisch eindpunt beschikbaar is in productie.
Referentieregels
- Bewaar clientgeheimen en toegangstokens alleen in een beveiligde, server-side geheimopslag.
- Leg nooit inloggegevens vast aan Git, documentatie, issue trackers, screenshots of voorbeeldapplicaties.
- Stuur nooit inloggegevens naar analyse- of logplatforms.
- Gebruik omgevingsspecifieke inloggegevens alleen in de omgeving waarvoor ze zijn uitgegeven.
- Roteer een referentie onmiddellijk als deze zichtbaar is.
- Autorisatieheaders en tokens van ondersteuningsaanvragen redigeren.
Browser versus server
De Web SDK maakt gebruik van door partners verstrekte browserconfiguraties. Een clientgeheim mag niet in de browser worden opgenomen.
Server-side integraties dienen de authenticatiestroom en eindpuntdefinities in de huidige goedgekeurde API-referentie te volgen. Indien een benodigde bewerking ontbreekt, dient u deze via Partner Engineering aan te vragen in plaats van een niet-gedocumenteerde route te construeren.
Webhooks
Server-push webhooks maken geen deel uit van de momenteel gepubliceerde Web SDK-documentatie. Controleer of u webhooks nodig heeft voordat u er een afhankelijkheid van ontwerpt.
Milieuchecklist
- [ ] De omgevingsnaam is gedocumenteerd.
- [ ] De basis-URL is afkomstig van de goedgekeurde referentie of onboarding-overdracht.
- [ ] Er zijn inloggegevens verstrekt voor die omgeving.
- [ ] Geheimen worden aan de serverzijde opgeslagen.
- [ ] Logboeken verwijderen tokens en klantafbeeldingen.
- [ ] Er zijn afspraken gemaakt over time-outs, herhaalpogingen en idempotentiegedrag voor schrijfbewerkingen.
- [ ] Een test buiten de productieomgeving slaagt voordat toegang tot de productieomgeving wordt gebruikt.