Skip to main content

Introducing API Submission - Seamless System Integration

· 4 min read

Streamline Your Workflow with Programmatic Data Submission​

We're excited to announce a powerful new feature that takes OSPROV's workflow capabilities to the next level: API Submission. This feature enables seamless integration between your existing systems and OSPROV workflows, allowing for automated data submission without manual intervention.

What is API Submission?​

API Submission is a RESTful API interface that allows external systems, applications, and scripts to programmatically submit data directly into OSPROV workflows. Instead of requiring users to manually fill out forms through the web interface, your systems can now automatically push data into approval workflows, making your processes more efficient and reducing manual overhead.

Key Benefits​

🔄 Automated Integration​

Connect your existing systems (HR platforms, procurement tools, IoT sensors, mobile apps) directly to OSPROV workflows. No more manual data entry or duplicate processes.

🛡️ Enterprise-Grade Security​

Built with security at its core, featuring:

  • 80-character Bearer token authentication
  • Dedicated API user accounts (separate from regular users)
  • Comprehensive request logging and audit trails
  • Rate limiting and abuse prevention
  • HTTPS-only communication

📊 Real-Time Processing​

Submitted data is processed immediately and enters your configured workflow, triggering notifications, approvals, and automated actions in real-time.

🎯 Flexible Data Handling​

Supports complex form structures including:

  • Text fields, numbers, dates, and booleans
  • File attachments and multi-select options
  • Nested data structures and table grids
  • Custom validation rules

How It Works​

The API Submission process is straightforward:

  1. Setup: Your administrator creates dedicated API user accounts with appropriate workflow permissions
  2. Authentication: Your system authenticates using secure Bearer tokens
  3. Submit: Send JSON data to the workflow endpoint matching your form structure
  4. Process: OSPROV validates the data and creates a submission in the workflow
  5. Track: Monitor submission status and receive confirmation responses

Simple Example​

curl -X POST "https://your-domain.com/api/submissions/workflow/123" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your-api-token" \
  -d '{
    "employee_name": "John Doe",
    "department": "Engineering",
    "request_type": "equipment",
    "justification": "New laptop for development work"
  }'

Real-World Use Cases​

HR Systems Integration: Automatically submit employee onboarding requests, leave applications, and performance reviews from your HR platform.

Procurement Automation: Connect purchasing systems to submit purchase orders, vendor requests, and budget approvals.

IoT and Monitoring: Have sensors and monitoring systems automatically create maintenance requests or alert workflows when thresholds are exceeded.

Mobile Applications: Enable field workers to submit inspection reports, incident reports, and service requests directly from mobile apps.

Customer Portals: Allow customers to submit support requests, feature requests, or service applications through your customer-facing systems.

Getting Started​

Ready to integrate your systems with OSPROV? Here's what you need to do:

  1. Contact Your Administrator: Request API user accounts and workflow permissions
  2. Review the Documentation: Our comprehensive API documentation covers everything from authentication to advanced integration patterns
  3. Start Simple: Begin with basic submissions and gradually add complexity
  4. Test Thoroughly: Use our troubleshooting guides and examples to ensure robust integration

Comprehensive Documentation Available​

We've created extensive documentation to help you succeed with API integration:

What's Next?​

API Submission represents a significant step forward in making OSPROV a true integration platform. We're already working on additional API endpoints for querying submission status, retrieving workflow data, and managing user permissions programmatically.

We'd love to hear about your integration use cases and feedback on this new feature. Share your experiences or questions in the comments below, or reach out to our support team for assistance with your specific integration needs.

Ready to get started? Visit our API Submission Documentation to begin integrating your systems with OSPROV today.