For detailed specifications required for system integration, please refer to the following documentation.
https://docs.api.teachme.jp
Note: The documentation is written in Japanese. Please translate it as needed on your end.
Overview
API integration is a mechanism for retrieving manual information from external systems or applications.
By using the API, you can access manual information not only from within Teachme Biz, but also from external systems.
Supported Plans
Please refer to the link below for information on the plans and options that include this feature.
- What 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.
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 capable of making and receiving API calls 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 API?
A. Yes.
The information that can be retrieved is limited to what is accessible to the user who issued the API key.
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 configured in multiple stages, and it is also possible to 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 API integration interruptions, 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, you can issue API keys with defined manual search scopes for each department and link them to the respective systems.
Q. Under IP address restrictions, is it possible to search for manuals via API from a non-permitted network?
A. Yes.
The API is not affected by IP address restrictions.
Q. When manual information is retrieved via API, does it count toward the manual's view count?
A. No.
Manual searches and information retrieval via 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.
Q. Is MCP (Model Context Protocol) supported?
A. No, it is not supported.
By building and implementing a program on your end that calls the API within your system or generative AI, the generative AI will be able to search and reference manual information.