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 check the link below for the plans and options that support 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.
API Detailed Specifications
For detailed specifications required for system integration, please refer to the following document.
https://docs.api.teachme.jp
* The documentation is written in Japanese. Please translate it on your end as needed.
Related Links
Issue and Delete Client IDs for API Integration (Web Browser)
Teachme Biz API Special Terms
Japanese: https://file.biz.teachme.jp/doc/teachmebiz_apiaccessplus_terms.pdf
English: https://file.biz.teachme.jp/doc/teachmebiz_apiaccessplus_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 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 the issued API key or integration settings?
A. Expiration dates can be set in multiple stages, and it is also possible to set no expiration date.
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 their respective systems.
Q. Under IP address restrictions, is it possible to use the API to search for manuals from a non-permitted network?
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 view count of the target manual?
A. No.
Manual searches and information retrieval via the API are not counted toward the manual's view count.
Q. Is technical support available during implementation?
A. Integration with your system will need to be handled on your end.