Review the technical and operational requirements for integrating with Kyndryl Bridge, including API authentication, hosting models, network setup, and licensing considerations.
This section details the technical, operational, and security requirements needed to onboard Partner applications to Kyndryl Bridge. Meeting these prerequisites ensures a smooth integration process and optimal service performance within the Kyndryl Bridge environment.
Integration level
Partners must determine the appropriate integration level (refer to Section 3) before proceeding with the integration steps. The selected level will dictate the technical requirements and implementation approach.
Partner application hosting and connectivity options (as applicable)
Hosting
Hosting is a critical prerequisite for partner integration, requiring infrastructure and services to deploy, operate, and manage the application. Hosting environments should accommodate the unique needs and scale of operations for each Partner application.
Partners must provide hosting information in cases where the application will be:
Developed as a Software as a Service (SaaS) application within Kyndryl’s environment.
Hosted in a dedicated Kyndryl-managed environment.
Ensuring these hosting prerequisites are met enables efficient integration with Kyndryl Bridge and enhances the performance and reliability of the application. For detailed hosting requirements, refer to Section 5.4A.
Network setup for security and integration preparation
A secure and robust network setup is essential for preparing Partner applications for integration with Kyndryl Bridge. This includes specific configurations and security measures tailored to the integration level.
Network configuration:
Establish secure communication channels between the Partner’s infrastructure and Kyndryl Bridge.
Implement firewalls, VPNs, and other network security tools as needed.
Firewall rules:
Define and enforce rules to regulate incoming and outgoing traffic.
Allow only the necessary ports and protocols to reduce the attack surface.
VPN setup:
Configure a Virtual Private Network (VPN) to establish a secure and encrypted connection between the Partner’s network and Kyndryl Bridge.
Protect data in transit from interception and tampering.
IP whitelisting (as applicable):
Whitelist Kyndryl Bridge IP addresses to ensure that only authorized traffic accesses the Partner’s network.
Add an extra layer of security by restricting access to trusted sources.
Compliance with security standards (as applicable):
Ensure adherence to relevant security standards and regulations, such as ISO/IEC 27001 and GDPR, to maintain high security and trust levels.
Note: The level of network integration will vary based on the chosen integration level. Partners are expected to:
Share network design details.
Confirm network settings to align with integration requirements.
Source of license (as applicable)
When configuring license settings for Production, Development, or Demo environments, Partners must ensure the setup aligns with the environment’s intended purpose to optimize resource utilization and operational efficiency.
Development/Test/Demo licenses:
Partners are required to provide development, test, or demo licenses for their applications.
License procurement:
In cases where demo licenses are unavailable, the Kyndryl team will collaborate with the Partner to determine how to procure the necessary licenses.
Secure API management – authentication and authorization support
This section outlines best practices for securely managing APIs, ensuring the integrity, confidentiality, and availability of data exchanged between Partner applications and Kyndryl Bridge.
API authentication
Implement robust authentication mechanisms to verify the identity of users and applications accessing APIs:
OAuth 2.0:
Use secure token-based authentication with OAuth 2.0 for enhanced security.
API keys:
Generate and manage API keys to regulate access to API endpoints.
API authorization
Ensure proper permissions are assigned to users and applications accessing APIs:
Role-based access control (RBAC):
Use RBAC to define user roles and assign permissions accordingly.
Scopes:
Establish scopes to restrict access to specific API functionalities, limiting exposure to unnecessary data.
Data encryption (as applicable)
Protect sensitive data through encryption during transit and storage:
TLS/SSL:
Use Transport Layer Security (TLS) or Secure Sockets Layer (SSL) to encrypt data exchanged between clients and servers.
Encryption at rest:
Secure sensitive data stored in databases and other storage systems using encryption methods.
Rate limiting and throttling
Mitigate API abuse and ensure fair usage through request control measures:
Rate limiting:
Define limits for the number of API requests permitted within a given timeframe.
Throttling:
Control the rate at which API requests are processed to prevent server overload and ensure stability.
API monitoring and logging (optional)
Track API activity to identify and respond to security incidents effectively:
Logging:
Record details such as timestamps, IP addresses, user identifiers, and metadata for API requests and responses.
Monitoring:
Use tools to monitor API performance and detect unusual patterns or suspicious activity.
Regular audits and penetration testing
Conduct ongoing evaluations to identify and mitigate security vulnerabilities:
Security audits:
Periodically review API security configurations and practices to ensure compliance.
Penetration testing:
Simulate potential attacks to identify weaknesses in API security and implement necessary fixes.
Connecting Partner applications via user interface (as applicable)
When Single Sign-On (SSO) is enabled, integrating the Kyndryl Bridge User Interface (UI) focuses on navigation links and testing the launch and landing onto Partner UI pages. To facilitate integration from the Kyndryl Bridge UI, Partners need to support URL-based UI page navigation that can be configured within the Kyndryl Bridge Integration UI. This configuration allows for the launch of Partner applications from the Kyndryl Bridge dashboard.
If the Partner application supports UI navigation links (e.g.,/app/dashboard/x or /app/dashboard/y), specific UI pages can be launched directly from Kyndryl Bridge. This enhances user experience by providing direct access to relevant sections of the Partner application.
Example navigation links:
/app/dashboard/x
/app/dashboard/y
If the Partner application does not support navigation links for specific UI pages, navigation capabilities from Kyndryl Bridge to the Partner application will be limited. In such cases, the URL would direct users to the home page of the Partner application, without the option to land on specific pages.
Example home page URL:
/app/dashboard
Access to Partner application API SDK (as applicable)
Partners are required to provide access to their API documentation and Software Development Kits (SDKs), including details on generating access tokens and creating request payloads for API calls. With the implementation of API and Data Gateways, integration complexities are reduced, as the Integration Platform as a Service (iPaaS) layer manages API integration across applications.
Partner application support processes (ITIL) (as applicable)
Maintenance and upgrades
Ongoing and scheduled maintenance and upgrades are essential to keep the solution up-to-date, optimized, and secure. This includes:
Regular updates:
Addressing bugs, security vulnerabilities, and performance enhancements.
Upgrade path:
Providing clear guidelines and procedures for upgrading to newer versions of the solution.
Support and service level agreements (SLAs)
Providing reliable support and adhering to SLAs is crucial for partner satisfaction. This includes:
Support channels and response times:
Offering multiple support channels such as email, phone, and chat, with defined response and resolution times.
Training and resources:
Supplying training materials and resources to help Kyndryl teams effectively use and support the solution.
Escalation procedures:
Establishing clear escalation paths for unresolved or critical issues.
Process for white-labeling partner applications (if feasible)
Partners should provide options for white-labeling their applications, allowing customization to align with Kyndryl’s branding requirements. This includes enabling the replacement of original logos with custom logos as specified by Kyndryl.
Training materials (as applicable)
Partners are expected to provide comprehensive training materials for their applications, including:
User guides
Sandbox environments for learning and exploration
Onboarding guides
API documentation
Deployment, installation, and upgrade guides
Training videos and tutorials
Release notes
Security best practices
Troubleshooting guides and FAQs
Support contact information
API documentation
Partners should publish detailed API documentation that includes:
Authentication methods:
Information on how to authenticate API requests.
Authorization details:
Guidelines on access control and permission levels.
Available endpoints:
A list of API endpoints with request and response formats.
Response and error codes:
Definitions of standard response codes and error handling procedures.
Sample requests and responses:
Examples to illustrate how to interact with the APIs.
Rate limiting information:
Details on API usage limits and throttling policies.