Integrate with Epycbyte
Welcome to the guide on integrating with Epycbyte. This document will walk you through creating and managing integrations, ensuring a smooth experience for both you and your users.
Table of Contents
- Understanding Native Integrations
- Creating an Integration
- Creating a Product Integration
- Viewing and Managing Integrations
Understanding Native Integrations
Native integrations on Epycbyte allow third-party developers to extend the platform's functionality. These integrations are built directly into the system, ensuring seamless integration with minimal effort.
Key characteristics of native integrations:
- Direct Integration: No external APIs or middleware needed.
- Prebuilt Components: Use existing components to reduce development time.
- Strong Support: Epycbyte provides robust support for all native integrations.
Creating an Integration
To create a new integration, follow these steps:
Integration Form Fields
When creating an integration, you'll need to provide the following information:
- Name:
- A unique identifier for your integration.
- Description:
- A brief overview of what the integration does.
- Integration Type:
- Choose between "Native" or "Custom."
- Visibility Settings:
- Control who can see and use your integration.
- Support Email:
- Provide an email for users to contact you with questions.
Creating a Product Integration
If you're creating a product integration, ensure the following:
- Installation Flow:
- Simplify the process for new users while allowing existing users to sign in during installation.
- Documentation:
- Clearly explain how to use the integration and its features.
- Default Settings:
- Set sensible defaults to reduce user confusion.
Viewing and Managing Integrations
Once your integration is created, you can manage it through the Integrations Console:
- View Integration Details:
- Access logs for troubleshooting.
- Check Installation Logs:
- Use filters to view specific request types (e.g., errors).
- Community Badge:
- Available after submission, indicating community-driven projects.
Community Integrations
Community integrations are developed by third parties and supported solely by the developers. Before installing, review their Privacy Policy and End User License Agreement.