API integration is a mechanism for retrieving manual information from external systems and applications.
By using the API, you can access manual information not only from within Teachme Biz, but also from external systems.
Overview
Supported Plans
Please refer to the link below for the plans and options that support this feature.
- Which features are available for each subscription plan?
- How to check your subscription plan and options
Details
Manual List API
Retrieves a list of registered manuals.
Manual Details API
Retrieves detailed information for each manual.
API Detailed Specifications
For detailed specifications required for system integration, please refer to the following documentation.
https://docs.api.teachme.jp
* The documentation is written in Japanese. Please translate it as needed on your end.
Related Links
Issue and Delete Client IDs for API Integration (Web Browser)
Teachme Biz API Access Plus Supplemental Terms
Japanese：https://file.biz.teachme.jp/doc/teachmebiz_apiaccessplus_supplemental_terms.pdf
English：https://file.biz.teachme.jp/doc/teachmebiz_apiaccessplus_supplemental_terms_e.pdf
Frequently Asked Questions
Q. What kinds of external tools can be integrated?
A. In theory, any system that can call and receive API responses can be integrated, including in-house developed systems, commercial chatbots, generative AI tools, and more.
Q. Are there any restrictions on the information that can be retrieved via the API?
A. Yes.
The information that can be retrieved is limited to what the user who issued the API key is permitted to view.
Manuals that the user who issued the API key cannot view cannot be retrieved.
Q: Can an expiration date be set for issued API keys or integration settings?
A. Expiration dates can be set in multiple stages, and you can also set them to never expire.
However, please note that if the user who issued the API key is removed from the group, the integration will stop.
To prevent unintended interruptions to API integration, we recommend creating a dedicated user account for issuing API keys.
Q. Can multiple API keys be configured in our own system?
A. Yes.
For example, it is possible to issue API keys with defined manual search scopes for each department and connect them to their respective systems.
Q. Under IP address restrictions, can the API be used to search manuals from a network that is not on the allowlist?
A. Yes.
The API is not affected by IP address restrictions.
Q. When manual information is retrieved via the API, does it count toward the manual's view count?
A. No.
Manual searches and information retrieval via the API are not counted toward the manual's view count.
Q. Is technical support available for implementation?
A. Integration with your system will need to be handled on your end.