BA session
How brand ambassadors will sign in and submit. Not yet available.
Warning:
Arrives with the BA portal cutover
Nothing on this page can be called yet. It describes what is planned so a port can be designed around it. The two paths below answer 404 today, and the two errors are in the catalogue but no call returns them.
Brand ambassadors submit codes for consumers from the BA portal. Today the portal calls Seebait itself, with a token inside the app. After the cutover it will call this API with a session per agent, and no token will ship in the app.
The planned calls
| Call | What it will do | Status |
|---|---|---|
POST /api/v1/agent/session | Sign an agent in with their sign-in id and PIN. Returns a bearer token valid for 12 hours. | Not yet available |
GET /api/v1/agent/me | The agent and the campaigns they are assigned to. | Not yet available |
POST /api/v1/submissions with a session token | The same call as today, with the agent's token in Authorization and the campaign in UTC-Campaign. | Not yet available with a session; works today with a campaign key |
What will differ from a campaign key
- The campaign comes from a header. A campaign key belongs to one campaign. An agent may work several, so
UTC-Campaignwill be required and must name one of theirs, or the call is 403campaign_not_assigned. - Sessions expire. After 12 hours, or when ops revokes one, calls answer 401
session_expired. Keep what the agent typed, sign in again, and send it with the sameIdempotency-Key. - The portal runs in a browser, so calls will be allowed only from the BA portal's own origins.
- Everything after sign-in is the same: the same submission, the same outcomes, the same messages. Port the reply handling now, against a campaign key and the sentinels.
For how Seebait's replies become message_key, see Seebait mapping.