Pag-access at Pagpapatotoo ng API

Ang SPREEAI ay nagbibigay ng pampublikong API reference para sa mga inaprubahang workflow ng partner: https://docs.spreeai.com/swagger/public/.

Modelo ng pag-access

Ang saklaw ng API, kapaligiran, mga kredensyal, at mga pinapayagang operasyon ay napagkasunduan habang onboarding ng partner. Huwag ipagpalagay na mayroong internal, development, o historical endpoint na available sa production.

Mga tuntunin sa kredensyal

• Iimbak lamang ang mga sikreto ng kliyente at mga token ng access sa isang ligtas na server-side secret store.
• Huwag kailanman mag-commit ng mga kredensyal sa Git, dokumentasyon, mga issue tracker, mga screenshot, o mga sample na application.
• Huwag kailanman magpadala ng mga kredensyal sa mga analytics o logging platform.
• Gamitin lamang ang mga kredensyal na partikular sa kapaligiran para sa kapaligirang pinag-isyuhan ng mga ito.
• I-rotate kaagad ang isang kredensyal kung ito ay malantad.
• Alisin ang mga authorization header at token mula sa mga kahilingan sa suporta.

Browser laban sa server

Gumagamit ang Web SDK ng configuration ng browser na inisyu ng partner. Hindi dapat kasama ang isang client secret sa browser.

Dapat sundin ng mga server-side integration ang authentication flow at mga kahulugan ng endpoint sa kasalukuyang inaprubahang API reference. Kapag walang kinakailangang operasyon, hilingin ito sa pamamagitan ng Partner Engineering sa halip na bumuo ng isang hindi dokumentadong ruta.

Mga Webhook

Ang mga server-push webhook ay hindi bahagi ng kasalukuyang nailathalang dokumentasyon ng Web SDK. Kumpirmahin ang anumang kinakailangan sa webhook bago magdisenyo ng dependency dito.

Tskribi sa kapaligiran

• [ ] Nakadokumento ang pangalan ng kapaligiran.
• [ ] Ang base URL ay nagmula sa inaprubahang reference o onboarding handoff.
• [ ] Nagbigay ng mga kredensyal para sa kapaligirang iyon.
• [ ] Ang mga sikreto ay nakaimbak sa server-side.
• [ ] Sinusuri ng mga log ang mga token at imahe ng customer.
• [ ] Napagkasunduan na ang mga timeout, retries, at idempotency behavior para sa mga write operation.
• [ ] Magtatagumpay ang isang pagsubok na hindi pang-produksyon bago magamit ang access sa produksyon.