Resources
Frequently Asked Questions
Answers to the most common questions about integrating with the Business Signal Operating System (BSOS) API.
Getting Started
What is the BSOS API?
The BSOS API allows applications to submit business signals and receive structured priority decisions that can be integrated into existing business workflows.
How do I get started?
Begin with the Quick Start guide, generate an API key, authenticate your requests, and send your first signal to the API.
Do I need an SDK?
No. BSOS is a REST API and can be used from any programming language capable of making HTTPS requests.
Authentication
How do I authenticate?
Every request must include your API key using the Authorization header with the Bearer authentication scheme.
Can I regenerate my API key?
Yes. Creating a new API key immediately invalidates the previous one.
What should I do if my API key is exposed?
Revoke the compromised key immediately and generate a new one from the Developer Dashboard.
API Requests
Which content type is supported?
All requests and responses use JSON.
Does the API require HTTPS?
Yes. All communication with the BSOS API must use HTTPS.
Is the API versioned?
Yes. Every endpoint belongs to a specific API version to ensure long-term compatibility.
Errors
Why am I receiving a 401 Unauthorized response?
Your API key is missing, invalid, expired, or has been revoked.
Why am I receiving a 403 Forbidden response?
Your API key is valid but does not have permission to access the requested workspace or resource.
Why am I receiving a 429 Too Many Requests response?
Your application has exceeded the current request limit. Retry the request after the recommended interval.
Security
Is customer data encrypted?
Yes. All communication uses TLS encryption and sensitive data is protected according to the platform security model.
Does BSOS support tenant isolation?
Yes. Each workspace is logically isolated to ensure that customer data remains separated from other organizations.
Should API keys be stored in frontend applications?
No. API keys should always be stored securely on your backend.
Integration
Can BSOS integrate with Gmail?
Yes. Gmail integration is supported through the BSOS platform.
Can BSOS integrate with Microsoft 365?
Yes. Microsoft 365 integration is supported.
Can I integrate BSOS with my CRM?
Yes. BSOS is designed to integrate with CRM, ERP, Helpdesk, and other enterprise applications.
Support
Where can I report a bug?
Technical issues can be reported through the Developer Portal support channels.
Where can I find API updates?
All API changes are published in the Changelog section.
Where can I find additional examples?
The Examples section contains complete request and response examples for common integration scenarios.
Still have questions?
If you cannot find the answer in this documentation or need assistance with your integration, our team is happy to help.
Contact us at hello@priorityengineai.com
Contact Developer Support