API Proxy
The Subnoto API Proxy is a secure gateway container that provides access to Subnoto’s signature services. It acts as a bridge between your applications and our secure enclave infrastructure, handling authentication, request routing, and secure communication.
Purpose
Section titled “Purpose”The API Proxy serves several key functions:
- Security Gateway: Provides a secure entry point to Subnoto’s signature services
- Authentication Hub: Manages API credentials and session handling
- Request Routing: Routes requests to the appropriate backend services
- Compliance: Ensures all communications meet regulatory requirements
Key Features
Section titled “Key Features”- Secure Communication: All communications are encrypted and authenticated
- Scalable Architecture: Designed for high availability and performance
- Easy Integration: Simple REST API for seamless application integration
- Containerized: Deploy anywhere using Docker or Kubernetes
Getting Started
Section titled “Getting Started”Frequently Asked Questions
Section titled “Frequently Asked Questions”Should I use the API proxy or call enclave.subnoto.com directly?
Section titled “Should I use the API proxy or call enclave.subnoto.com directly?”All API endpoints must go through the API proxy container. The enclave.subnoto.com endpoint should not be called directly. The API proxy is the required gateway for all Subnoto API requests, providing secure authentication, session management, and request routing.
Can I create envelopes with multiple documents?
Section titled “Can I create envelopes with multiple documents?”Currently, only one document per envelope is supported, both via the API and the user interface. This is a current limitation of the platform.
Why is workspaceUuid required in every request?
Section titled “Why is workspaceUuid required in every request?”The workspaceUuid parameter is required to specify which workspace the envelope or resource will be added to. This ensures proper data isolation and organization. Best practice: Create a dedicated workspace for envelopes created via the API to keep them organized separately from manually created envelopes.
Can I restrict API keys to specific workspaces?
Section titled “Can I restrict API keys to specific workspaces?”API key workspace restrictions are not currently available. This feature will be added in a future release, allowing you to limit API keys to access only specific workspaces.