API Submission

The API Workflows feature allows external systems to submit data directly to OSPROV workflows through RESTful API endpoints. This enables powerful integration capabilities, allowing other applications to programmatically create submissions without requiring manual data entry through the web interface.

What are API Workflows?

API Workflows are regular OSPROV workflows that have been configured to accept data submissions via HTTP API requests. Any workflow can potentially be accessed via API, but access is controlled through:

1. API User Authentication: Only valid API users can submit data
2. Workflow Permissions: Users must have appropriate permissions for specific workflows
3. Workflow Status: Workflows must be active and not expired
4. Rate Limiting: System-wide limits prevent abuse

How It Works

Architecture Overview

External System → API Request → Authentication → Validation → Workflow Processing → Response

Request Flow

1. External System prepares JSON data matching the workflow's form structure
2. Authentication using Bearer token from API User account
3. Rate Limiting checks ensure request limits are not exceeded
4. Workflow Validation confirms the workflow exists and is accessible
5. Form Validation ensures submitted data matches form requirements
6. Data Processing creates the submission and triggers workflow processing
7. Response returns success confirmation or error details
8. Logging records the API request for monitoring and audit

What's in this section

• Getting Started - Prerequisites and basic setup for API submissions
• API Users Management - Creating and managing API user accounts
• Authentication - API token authentication and security
• Request Format - JSON structure and field type mapping
• Response Formats - Understanding API responses and error codes
• Rate Limiting - Request limits and handling strategies
• Form Validation - Dynamic validation and input masks
• Security Features - Input sanitization and audit trails
• Real-World Examples - Practical integration scenarios
• Troubleshooting - Common issues and solutions