For detailed specifications required for system integration, please check the Documents here.
https://docs.api.teachme.jp
※ The Documents are written in Japanese.
Please translate them on your end as needed.
Overview
API Integration is a mechanism for retrieving manual information from external systems or applications.
By using the API, manual information can be accessed not only from within Teachme Biz but also from external systems.
Supported Plans
For information on the plans and Options available for this feature, please check here.
Details
The API can retrieve text information from Manuals currently published.
Manuals cannot be created, edited, or Deleted via the API.
Manual List API
You can retrieve a list of registered manuals.
Up to 100 items can be retrieved per call.
You can retrieve all manuals by calling subsequent results as the Next Page.
If a keyword is specified, up to 100 related manuals are retrieved in order of relevance (there is no Next Page in this case).
For each manual, you can retrieve the Manual ID, URL, Title, cover description, and the folder containing the manual.
Manual Detailed information API
You can retrieve Detailed information for each manual.
In addition to the information available through the list API, you can also retrieve the contents of Steps and the custom fields of the cover and Steps.
Groups using the automatic translation feature can also retrieve content translated into a specified language.
Information that can be retrieved
- Manual ID, manual URL
- Title, cover description
- Step Title, Step description (Manual Detailed information API only)
- Custom field names and entered content for the cover and Steps (Manual Detailed information API only)
- The name and hierarchy of the folder containing the manual
Information that cannot be retrieved
- Images and videos of the cover and Steps
- Marking applied to images or videos, and video subtitles
- Related manuals, Outside Links, and Location Data on the cover
- Manuals in draft status
- Information related to manual management, such as view count, creator, and last updated date/time
- Information other than manuals, such as users and Training
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
FAQ
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 internally developed systems, commercial Chat bots, and generative AI tools, among a wide range of others.
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 the scope 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. The Expiration Date can be set in multiple stages, and it is also possible to set it to no expiration.
However, please note that if the user who issued the API key is Deleted from the Group, the integration will be suspended.
To prevent unintended suspension of API Integration, we recommend creating a dedicated user account for issuing API keys.
Q. Can multiple API keys be configured in our system?
A. Yes.
For example, it is possible to issue API keys with defined manual search scopes for each department and integrate them with their respective systems.
Q. Under an IP address restriction, is it possible to search for manuals via the API from a network that is not permitted?
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 targeted 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 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 tool, you will be able to search and reference manual information from generative AI.