What is the Feishu-Common Skill?
The Feishu-common skill is a shared authentication and API helper designed
specifically for OpenClaw Feishu skills. This skill serves as a foundational
component that provides essential functionality for other Feishu-related
skills to operate effectively within the OpenClaw ecosystem.
Core Features and Functionality
The Feishu-common skill provides several key features that make it an
indispensable tool for developers working with Feishu integrations:
Tenant Token Acquisition and Caching
One of the primary functions of this skill is managing tenant tokens. These
tokens are essential for authenticating requests to Feishu's API. The skill
handles the acquisition of these tokens and implements a caching mechanism to
ensure optimal performance and reduce unnecessary API calls.
Retry and Timeout Handling
Network reliability is crucial for any API integration. The Feishu-common
skill includes robust retry logic and timeout handling to ensure that API
requests are resilient to temporary network issues or service disruptions.
This feature helps maintain the stability and reliability of dependent skills.
Authenticated Request Wrapper with Token Refresh
The skill provides a convenient wrapper for making authenticated requests to
Feishu's API. This wrapper automatically handles token refresh when necessary,
ensuring that requests remain authenticated without requiring manual
intervention from developers.
Installation and Usage
Before using any dependent Feishu skills, developers must first install the
Feishu-common skill. This installation ensures that all necessary dependencies
and configurations are in place for other skills to function correctly.
Importing the Skill
Dependent skills can easily import the required functions from the Feishu-
common skill using the following syntax:
const {
getToken,
fetchWithRetry,
fetchWithAuth
} = require("../feishu-common/index.js");
Compatibility Alias
For added convenience, the skill also provides a compatibility alias that
developers can use:
const {
getToken,
fetchWithAuth
} = require("../feishu-common/feishu-client.js");
Key Files and Structure
The Feishu-common skill consists of two main files:
index.js
This file contains the main implementation of the skill, including all core
functionality for authentication, token management, and API request handling.
feishu-client.js
This file serves as a compatibility alias to index.js, providing an
alternative import path for developers who prefer this naming convention.
Benefits for Developers
By using the Feishu-common skill, developers can significantly reduce the
complexity of building Feishu integrations. The skill handles many of the
common challenges associated with API authentication and request management,
allowing developers to focus on building the core functionality of their
skills rather than dealing with boilerplate code.
Integration with the OpenClaw Ecosystem
The Feishu-common skill is designed to work seamlessly within the broader
OpenClaw ecosystem. As part of the OpenClaw skills repository, it follows
established patterns and conventions that ensure compatibility with other
OpenClaw skills and tools.
Best Practices for Using the Skill
When incorporating the Feishu-common skill into your projects, consider the
following best practices:
- Always install the skill before using any dependent Feishu skills
- Use the provided import statements to ensure compatibility
- Take advantage of the built-in retry and timeout handling
- Allow the skill to manage token refresh automatically
- Handle errors appropriately in your dependent skills
Conclusion
The Feishu-common skill is a powerful tool that simplifies the development of
Feishu integrations within the OpenClaw ecosystem. By providing shared
authentication, API helpers, and robust error handling, it enables developers
to create more reliable and maintainable Feishu skills with less effort.
Whether you're building a simple Feishu integration or a complex multi-skill
application, the Feishu-common skill provides the foundation you need for
success.
Skill can be found at:
common/SKILL.md>
Top comments (0)