KAIYUN Platform: Your Developer Guide

Introduction

To create extensions that improve functionality and bring joy to users, it's important to focus on user-centered design, thoughtful layout strategies, and effective use of color and typography. Let's explore how you can seamlessly integrate your extensions with the Simple experience. If you plan to publish your App on the Marketplace, please review our Platform Application Design Guide for the Design and Usability section.

Crafting your interface

KAIYUN platform applications run in an isolated environment, allowing you to develop interfaces using standard HTML, CSS, and JavaScript, similar to building a single-page application. Feel free to use various frameworks and libraries, such as React or Vue for UI components, and style them with Tailwind CSS or Bootstrap.

While KAIYUN platform applications are not strictly required to be native, we believe that applications offering a native-like experience will attract more users and provide superior usability.

Design principles

Your interface should adhere to these key design principles:

• User-Centric: Define your application's goals and value around user needs, addressing their unique pain points.
• Simplicity and Ease of Use: Applications should be intuitive, requiring minimal learning to operate, and complement visual abstractions rather than complicating them.
• Design Consistency: Maintain uniformity in design elements like colors, typography, and button styles throughout your application to enhance user experience and navigation.
• Foster Creative Flow: Your application should not impede the creative process; avoid unnecessary steps or options that disrupt the user's focus.
• Clear Language: Use concise and straightforward copy to guide users in understanding the relationship between visuals, layout, and usability.
• Accessibility: Strive to make your application accessible to all users by adhering to relevant standards and best practices.

Design guidelines

Select a color scheme that aligns with your application's goals and aesthetic. KAIYUN platform primarily uses the Inter font; consistency is recommended.

Handling Common Errors

If you encounter this error, check if your application is exceeding request frequency limits. For example, frequent polling while waiting for resource creation or making numerous high-concurrency API calls can trigger this issue.

{
    Messages: "Too Many Requests",
    Error Codes: "too_many_requests",
    External References: Empty,
    Details: [],            
}

API Integration

Our APIs interact with the platform through user-friendly objects and methods. You can utilize these APIs to interact with existing elements or add new ones to the platform.

Conclusion

Let's explore the core files needed for building application structure, styling, and dynamic content. You can delve deeper into application configuration, structure, and necessary files within the documentation. Experiment freely as you explore and modify the project skeleton.

Practice is the best way to learn. The project skeleton provides a safe environment for experimentation.