Skip to content

Integration & Interoperability

Epic Overview

EPIC: Integration & Interoperability

DESCRIPTION: Develop a comprehensive integration framework that enables the platform to seamlessly connect with the Velocity Network, Velocity Credential Agent, and other third-party services. The system will support standard data formats for exports and exchanges, implement APIs for external system integration, and ensure interoperability across the digital credentialing ecosystem.

BUSINESS VALUE: Enables the platform to function within the broader Velocity Network ecosystem, leveraging existing components and services to accelerate development and reduce risk. The integration capabilities allow for data exchange with external systems, enhancing the platform's utility and supporting a connected credentialing environment.

STAKEHOLDERS: - REC (Platform Owner) - Velocity Career Labs (VCL) - Velocity Network Foundation (VNF) - Staffing Companies - Third-party Service Providers

SIZE: Large - Integration is a critical component that spans multiple systems and requires careful implementation.

USER STORIES: - As a platform administrator, I want to integrate with the Velocity Credential Agent so that the platform can issue and verify credentials on the Velocity Network. - As a platform administrator, I want to integrate with the Velocity Network Registrar so that organizations can be properly registered on the network. - As a platform administrator, I want to integrate with third-party services like SMS gateways and email services so that the platform can send notifications. - As a platform administrator, I want to support standard data formats for exports and exchanges so that data can be easily shared with other systems. - As a staffing company administrator, I want to export credential data in standard formats so that I can use it in other systems. - As a developer, I want access to well-documented APIs so that I can integrate other systems with the platform. - As a platform user, I want a seamless experience when interacting with components from different systems so that I don't notice the underlying integrations.

Implementation Details

The Integration & Interoperability system includes:

  1. Velocity Credential Agent Integration
  2. API integration for credential issuance
  3. API integration for credential verification
  4. Synchronization of credential status
  5. Error handling and retry mechanisms

  6. Co-location of infrastructure with the Credential Agent

  7. Velocity Network Integration

  8. Integration with Velocity Network Registrar API
  9. Support for Velocity Network credential types
  10. Compliance with Velocity Network protocols

  11. Reuse of VNF and VNF-enabled open-source solutions

  12. Third-party Service Integration

  13. SMS gateway integration for notifications
  14. Email service integration for communications
  15. PDF generation service integration for reports

  16. Integration with identity verification services

  17. Data Exchange Standards

  18. Support for CSV exports of credential data
  19. Support for JSON data exchanges
  20. Support for XML data exchanges where required

  21. Standardized data formats and schemas

  22. API Development

  23. RESTful API design
  24. API documentation using OpenAPI/Swagger
  25. API versioning strategy
  26. Authentication and authorization for API access

  27. Rate limiting and throttling

  28. Interoperability Framework

  29. Common data models across integrations
  30. Transformation services for data mapping
  31. Event-driven architecture for real-time updates
  32. Monitoring and logging of integration points

Dependencies

  • Velocity Credential Agent (provided by VCL)
  • Velocity Network Registrar API
  • Third-party service APIs (SMS, email, etc.)
  • API development and documentation tools
  • Integration testing framework

Integration Requirements

  • The Velocity Credential Agent will be provided by VCL and hosted on co-located infrastructure
  • The platform must be able to interact with all Velocity Network credential types, even those not part of the initial MVP
  • Integration with VerifyMyCreds for credential verification
  • PDF generation will be handled by an existing service provided by VCL
  • The platform should be designed to easily incorporate additional integrations in the future