For detailed specifications required for system integration, please refer to the following Documents here.
https://docs.api.teachme.jp
※ The Documents are written in Japanese.
Please translate them as needed on your end before use.
Overview
API Integration is a mechanism for retrieving Manual information from external systems or applications.
By using the API, it becomes possible to access Manual information not only from within Teachme Biz, but also from external systems.
Supported Plans
Please refer to the links below for the plans and Options that support this feature.
Details
The API can retrieve text information from Manuals currently published.
Creating, editing, or deleting Manuals via the API is not supported.
Manual List API
You can retrieve a list of registered Manuals.
A single call can retrieve up to 100 items.
By calling the Next Page, you can retrieve all Manuals.
If a keyword is specified, up to 100 related Manuals are retrieved in order of relevance (no Next Page available).
For each Manual, you can retrieve the Manual ID, URL, Title, cover description, and the Folder the Manual is stored in.
Manual Details API
You can retrieve Detailed information for each Manual.
In addition to the information available from the list API, you can also retrieve Step content and custom fields for the cover and Steps.
For Groups using the auto-translation feature, you can also retrieve translated content by specifying a language.
Information That Can Be Retrieved
- Manual ID, Manual URL
- Title, cover description
- Step Title, Step description (Manual Details API only)
- Custom field names and input content for the cover and Steps (Manual Details API only)
- Name and hierarchy of the Folder the Manual is stored in
Information That Cannot Be Retrieved
- Cover and Step images and videos
- Marking applied to images or videos, video subtitles
- Cover related Manuals, Outside Links, and Location Data
- Manuals in Draft status
- Management-related information such as Views, author, and last updated date
- 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 in-house developed systems, commercially available Chat bots, generative AI tools, and more.
Q. Are there 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 has permission 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. Yes, the Expiration Date can be set in multiple stages, and it is also possible to set it 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, it is possible to issue API keys with different Manual search scopes defined per department and integrate each one with the respective system.
Q. Under IP address restrictions, is it possible to search for Manuals via the API from a network that is not whitelisted?
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 Views of that Manual?
A. No.
Manual searches and information retrieval via the API are not counted toward the Manual's Views.
Q. Is technical support available during 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 from your system or generative AI tool, you will be able to search and reference Manual information from generative AI.