Overview
Cloud APIs let you interact with your Blnk Core instances through Blnk Cloud. They sit on top of Core and add capabilities that are difficult or costly to manage on your own, such as centralized authentication, audit logs, alerts, and workspace controls. You can use Cloud APIs to:- Access multiple Core instances through a single endpoint
- Authenticate requests using OAuth 2.0 or API keys
- Track activity with comprehensive audit logs
- Monitor operations with real-time alerts
- Apply advanced filters when querying data
How Cloud APIs work
Cloud APIs act as an intelligent layer between your application and your Blnk Core instances:
- Your app authenticates with Blnk Cloud using an access token or an API key.
- Blnk Cloud validates the request and logs it for audit purposes.
- Your request is processed in your workspace.
- If it’s a proxy request:
- It’s forwarded to the correct Core instance using
instance_id. - The Core instance processes the request and returns the response.
- Blnk Cloud returns the response to your app.
- It’s forwarded to the correct Core instance using
- If it’s a direct request, Blnk Cloud processes the request and returns the response to your app.
What Cloud APIs add to Core
While Blnk Core provides all the ledger operations, Cloud APIs extend it with premium add-on features:OAuth authentication
Secure, token-based authentication with scoped permissions for different operations.
Audit logging
Track every action in your system with detailed audit logs for compliance and debugging.
Advanced filters
Query your data with powerful operators like
_between, _in, _like, and more.Real-time alerts
Set up alerts to notify you when specific conditions are met in your ledger.
Workspace management
Organize teams, manage permissions, and control access across your organization.
Multiple instances
Access multiple Core instances through a single API endpoint using
instance_id.Direct Core access vs. Cloud APIs
You can access your Blnk Core instance directly without using Cloud APIs. When doing so, Core continues to handle all ledger operations, but Cloud-specific capabilities are not available. This includes audit logs, alerts, OAuth authentication, advanced filtering, and workspace management.| Feature | Direct Core Access | Through Cloud APIs |
|---|---|---|
| Ledger operations | ✅ | ✅ |
| Balance management | ✅ | ✅ |
| Transaction processing | ✅ | ✅ |
| OAuth authentication | ❌ | ✅ |
| Audit logging | ❌ | ✅ |
| Triggering alerts | ❌ | ✅ |
| Advanced filtering | ❌ | ✅ |