Headless API integration (overview)

If you want to build your own assessment UI (web/mobile) and integrate with B5.ly via API:

• Interactive reference: /developer/b5plus-v2.reference.html
• OpenAPI spec: /developer/b5plus-v2.openapi.yaml
• Postman collection: /developer/b5plus-v2.postman.json
• Partner integration guide: /developer/b5plus-partner-headless-guide.md

Recommended workflow:

1. Start assessment session (v1)
2. Fetch items and render questions
3. Submit answers and finalize to get resultId
4. Create paid report (v2) to get reportId
5. Fetch report JSON and render results

Portal visibility:

• In the Partner Portal, view an audit trail of paid report purchases (credit debits + Report IDs + Result IDs) at /portal/activity (Report IDs link to the portal report view). Use the Source filter (All / Portal / API) and Export CSV for reconciliation.
• Result ID maps to the resultId returned by the headless flow (sometimes surfaced as extResultId / ext_result_id).
• Customers/Lists/Reports in the portal are invite/list-driven; headless API calls won’t create those rows automatically, so API-generated reports may not include name/email/list/package in the portal (a placeholder like API-<ResultID> may be shown where needed).
• Store partnerUserRef, resultId, and reportId in your system if you need customer-level reconciliation.