跳到主要内容
Mindtouch成功中心

API参考

欢迎来到MindTouch API参考文档!本指南是你开始利用MindTouch API创建高级内容集成、自动化工作流和下载分析数据的起点。将API文档从以前的指南迁移到这个位置是一项持续的工作。欢迎您老来浏览API调用指南如果尚未迁移到您要查找的API端点或使用案例,则尚未迁移。

介绍

MindTouch提供开箱即用,可易于配置,以形式集成接触点.接触点将您的内容扩展到其他web应用程序、CRM或网站。然而,MindTouch API可以与应用程序和系统集成,而无需web演示,如语音助手和物联网设备。此外,当MindTouch成为组织业务的关键部分时,与发布自动化系统、用户管理和翻译管理系统的集成可能是理想的。

这些类型的集成通常需要更高的复杂性和应用程序编程技能。虽然MindTouch API可以很容易地用于快速获取或动态更新内容,但当集成解除了将MindTouch功能扩展到组织关键部分的能力时,它的价值就实现了。

你有其他问题吗?尝试咨询MindTouch API常见问题。

入门

MindTouchAPI是围绕休息,位于/ @api / . .在Mindtouch网站上的相对网址。

https://example.com/@api/deki.

MindTouch网站(页面,用户,组等)上的每个资源都可以通过API获得。经过身份验证的MindTouch网站用户可以通过Web浏览器访问API,一旦他们签名到MindTouch网站。系统和应用程序集成需要使用API令牌来访问API。

HTTPS

MindTouch API通信用HTTPS固定。它可以通过HTTPS兼容客户端(如Web浏览器)私下和安全访问。MindTouch API域(MindTouch网站域)和集成所需的任何其他域都必须由HTTPS兼容的客户端或集成信任。为了避免因这些域旋转SSL / TLS证书时,为了避免破坏,它是强烈推荐信任证书颁发机构(CA)根证书和中间证书,而不是域的服务器证书。

除了MindTouch站点域之外,与MindTouch API的集成还依赖于与以下域的HTTPS通信:

  • * .cloudfront.net.
  • 文件.mtstatic.com

回应

默认HTTP响应内容类型为应用程序/xml;字符集=utf-8,而是一个application / json;charset = UTF-8如果API请求包括A.可以响应dream.out.format = json.http查询参数。

// XML编码响应https://example.com/@api/deki/pages/(//info // JSON编码响应https://example.com/@api/deki/pages/(}/info?dream.out.format=json.

默认情况下,一些API端点可能使用application / json;charset = UTF-8媒体类型或替代媒体类型。这些默认值在文档中注意到这些特定API端点的文档中。

状态代码

MindTouch使用传统的HTTP响应状态代码来指示API请求的成功或失败。状态代码2倍范围表示成功的请求。状态代码4倍范围表示请求的问题,例如缺少的URL查询参数或无效的HTTP Body格式。状态代码5 xx范围表示MindTouch API的意外内部问题,可以报告给Mindtouch支持团队

在罕见的场合,弃用并删除了API端点。如果在大多数情况下替换为新端点,则旧端点将重定向到新端点。为了使向后兼容保持兼容性,重要的是API客户端跟随地点HTTP标头,如果是的3xx.范围状态代码在HTTP响应中返回。

名称 价值 描述
好吧 200 请求已被成功处理并完成
公认 201 请求已被成功接受,并将在队列中处理
非权威信息 203 请求已被接受,但由于处理错误,响应包含部分完整的数据
搬到永久 301 API端点已弃用,并由一个新位置替换
成立 302 在处理请求之后,要返回的资源位于不同的URL
错误的请求 400 无效或缺少请求URL查询参数,无效的HTTP Body格式,或无效或缺少HTTP Body参数值
未经授权 401. 请求验证API端点失败
禁忌 403. 由于许可检查或因此,未访问所请求的资源授权无效
没有找到 404. 找不到请求的资源
走了 410. API端点已不推荐使用,并未用新位置替换

错误

从MindTouch API可以接收到两种可能的错误响应格式。这些格式的使用因错误和API端点的不同而不同,因此必须开发API集成来处理这两种格式。一些响应字段已经从这些示例中删除,因为它们包含与API集成无关的内部MindTouch元数据。

默认错误格式

 <异常> {例外}   {message}  

遗留错误格式(已弃用)

  {status}   {title} </ title> <message> {message} </ message> <uri> {uri} </ uri> </ ERROR></pre>
          <table class="mt-responsive-table">
           <thead>
            <tr>
             <th scope="col">名称</th>
             <th scope="col">类型</th>
             <th scope="col">描述</th>
            </tr>
           </thead>
           <tbody>
            <tr>
             <td data-th="Name">{例外}</td>
             <td data-th="Type">一串</td>
             <td data-th="Description">标识错误的唯一的、有名称空间的键</td>
            </tr>
            <tr>
             <td data-th="Name">{信息}</td>
             <td data-th="Type">一串</td>
             <td data-th="Description">错误的描述或问题的解释</td>
            </tr>
            <tr>
             <td data-th="Name">{地位}</td>
             <td data-th="Type">㈡</td>
             <td data-th="Description">HTTP状态代码(例如:400)</td>
            </tr>
            <tr>
             <td data-th="Name">{标题}</td>
             <td data-th="Type">一串</td>
             <td data-th="Description">HTTP状态名称(例如:错误请求)</td>
            </tr>
            <tr>
             <td data-th="Name">{uri}</td>
             <td data-th="Type">一串</td>
             <td data-th="Description">API端点URL</td>
            </tr>
           </tbody>
          </table>
         </div>
        </div>
       </div>
       <span id="92dd20ed910d468d6a35e42cd134f438"></span>
       <span id="Authorization_2"></span>
       <h2>授权</h2>
       <div class="mt-include" id="s15657">
        <p><a id="Tokens" name="Tokens"></a></p>
        <p>MindTouchAPI可以接收三种类型的令牌,以允许访问MindTouch站点数据。</p>
        <div class="mt-contentreuse-widget" data-page="Integrations/API/Authorization_Tokens" data-section="Token Attributes" data-show="false">
         <div class="mt-include" id="s14732">
          <ul>
           <li>所有令牌都被认为是一个明智的网站</li>
           <li>可以是单个字符串值或多个字符串值,例如密钥/秘密对</li>
           <li>令牌字符串值最长可达255个字符</li>
          </ul>
         </div>
        </div>
        <div mt-section-origin="Integrations/API/000_Getting_Started_With_the_API" class="mt-section" id="section_8">
         <span id="Auth_Token"></span>
         <h3 id="Auth_Token-15657">身份验证令牌</h3>
         <div class="mt-contentreuse-widget" data-page="Integrations/API/Types_of_Tokens" data-section="Auth Token" data-show="false">
          <div class="mt-include" id="s14732">
           <p><a id="Auth_Token_Anchor" name="Auth_Token_Anchor"></a></p>
           <p>auth代币(经常程式化为<em>authtoken</em>)在身份验证后在用户的Web浏览器中设置为HTTP cookie。MindTouch Auth代币是由Mindtouch网站生成的,并在加密签署以防止篡改。</p>
          </div>
         </div>
        </div>
        <div mt-section-origin="Integrations/API/000_Getting_Started_With_the_API" class="mt-section" id="section_9">
         <span id="Browser_API_Token"></span>
         <h3 id="Browser_API_Token-15657">浏览器API令牌</h3>
         <div class="mt-contentreuse-widget" data-page="Integrations/API/Types_of_Tokens" data-section="Browser API Token" data-show="false">
          <div class="mt-include" id="s14732">
           <p>浏览器API令牌从一个网站,web应用程序,或简单地任何运行在web浏览器的MindTouch API发送。令牌是用web浏览器可执行语言(如JavaScript)编写的。</p>
           <p>通常,谷歌Chrome或Mozilla Firefox等浏览器不允许运行在一个网站上的JavaScript应用程序访问另一个网站的数据。浏览器会阻止跨源的请求和响应,因为这会导致安全问题,特别是当一个网站的JavaScript应用程序使用另一个网站的cookie来冒充用户的身份进行不法活动时。然而,网站可以声明哪些第三方网站可以安全地访问其数据<a title="跨源资源共享(CORS)" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS" target="_blank" rel="external noopener nofollow" class="link-https">跨源资源共享(CORS)</a>.浏览器API令牌允许开发人员以安全和安全的方式实现CORS。除了CORS之外,浏览器API令牌还允许从MindTouch网站上的内容中执行的JavaScript中的javascript的同一原点API访问到同一站点的API。</p>
           <p>浏览器API令牌对API没有特定的用户权限来确定哪些操作是允许的,哪些操作是不允许的。用户权限是由web浏览器会话决定的<em><a title="authtoken" href="//www.sabbathabali.com/success/Integrations/#Auth_Token_Anchor" rel="internal">authtoken</a></em>HTTP cookie。如果访问集成的用户没有登录到MindTouch站点,那么API将该用户视为<a class="F1" title="匿名用户" href="//www.sabbathabali.com/success/Admin/Users_and_Groups/User_Management/User_types" rel="internal">匿名用户</a></p>
           <div class="mt-learningpath-widget" data-path-name="integrations-browser" data-show-pages="true">
            <div class="mt-lp-path-container mt-lp-path-container-integrations-browser " data-lp-name="integrations-browser" data-ga-action="Learning path view">
             <div class="mt-toggle mt-toggle-container mt-lp-pages-container f-lp-pages-container" data-ga-label="Toggle" data-title="View pages">
              <dl class="mt-listing-detailed">
               <dt class="mt-listing-detailed-title">
                <a title="授权使用MindTouch API集成web浏览器" data-ga-label="Learning path link" class="internal" href="//www.sabbathabali.com/success/@go/path/integrations-browser" rel="nofollow"><span class="mt-icon-article-lp"></span>授权使用MindTouch API集成web浏览器</a>
               </dt>
               <dd class="mt-listing-detailed-overview">
                授权MindTouch API和网站之间的集成,Web应用程序,Google Chrome应用程序或在Web浏览器中运行的任何内容。</dd>
               <dd class="mt-listing-detailed-pagecount">
                <span>页面:</span>2</dd>
               <dd class="mt-listing-detailed-subpages">
                <div class="mt-collapsible-section">
                 <ul class="mt-lp-page-listings mt-guide-listings" id="lp-pages-90">
                  <li class="mt-icon-lp-page">
                   <dl class="mt-listing-detailed">
                    <dt class="mt-listing-detailed-title">
                     <a title="获取浏览器API令牌" data-ga-label="Page link 1" class="mt-lp-page-link internal" href="//www.sabbathabali.com/success/Integrations/API/Authorization_Tokens/Get_a_Browser_API_Token?mt-learningpath=integrations-browser" rel="internal"><span class="mt-icon-article-howto"></span>获取浏览器API令牌</a>
                    </dt>
                    <dd class="mt-listing-detailed-overview mt-lp-page-overview">
                     为需要API访问的MindTouch web集成生成浏览器API令牌。</dd>
                   </dl></li>
                  <li class="mt-icon-lp-page">
                   <dl class="mt-listing-detailed">
                    <dt class="mt-listing-detailed-title">
                     <a title="使用具有集成的浏览器API令牌" data-ga-label="Page link 2" class="mt-lp-page-link internal" href="//www.sabbathabali.com/success/Integrations/API/Authorization_Tokens/Use_a_Browser_API_Token_With_an_Integration?mt-learningpath=integrations-browser" rel="internal"><span class="mt-icon-article-howto"></span>使用具有集成的浏览器API令牌</a>
                    </dt>
                    <dd class="mt-listing-detailed-overview mt-lp-page-overview">
                     使用浏览器API令牌以获得浏览器访问MindTouch API的说明和示例。</dd>
                   </dl></li>
                 </ul>
                </div>
               </dd>
              </dl>
             </div>
            </div>
           </div>
          </div>
         </div>
        </div>
        <div mt-section-origin="Integrations/API/000_Getting_Started_With_the_API" class="mt-section" id="section_10">
         <span id="Server_API_Token"></span>
         <h3 id="Server_API_Token-15657">服务器API令牌</h3>
         <div class="mt-contentreuse-widget" data-page="Integrations/API/Types_of_Tokens" data-section="Server API Token" data-show="false">
          <div class="mt-include" id="s14732">
           <p>服务器API令牌用于创建服务器应用程序、物联网、机器人或任何可以通过HTTPS进行通信的东西与MindTouch API之间的集成。使用服务器API令牌的实现通常是用服务器执行语言编写的,如c#、Java、JavaScript (Node.js)、Python、Go和PHP。令牌由密钥和密钥组成,用于对API请求签名,允许有效请求通过并拒绝无效或过期的请求。令牌机密被保存在一个安全的地方,永远不应该以纯文本形式在互联网上共享或发送。</p>
           <div class="mt-learningpath-widget" data-path-name="integrations-server" data-show-pages="true">
            <div class="mt-lp-path-container mt-lp-path-container-integrations-server " data-lp-name="integrations-server" data-ga-action="Learning path view">
             <div class="mt-toggle mt-toggle-container mt-lp-pages-container f-lp-pages-container" data-ga-label="Toggle" data-title="View pages">
              <dl class="mt-listing-detailed">
               <dt class="mt-listing-detailed-title">
                <a title="授权与MindTouch API的服务器集成" data-ga-label="Learning path link" class="internal" href="//www.sabbathabali.com/success/@go/path/integrations-server" rel="nofollow"><span class="mt-icon-article-lp"></span>授权与MindTouch API的服务器集成</a>
               </dt>
               <dd class="mt-listing-detailed-overview">
                授权MindTouch API与服务器应用程序、物联网设备、机器人或任何可以通过HTTPS进行通信的东西之间的集成。</dd>
               <dd class="mt-listing-detailed-pagecount">
                <span>页面:</span>2</dd>
               <dd class="mt-listing-detailed-subpages">
                <div class="mt-collapsible-section">
                 <ul class="mt-lp-page-listings mt-guide-listings" id="lp-pages-91">
                  <li class="mt-icon-lp-page">
                   <dl class="mt-listing-detailed">
                    <dt class="mt-listing-detailed-title">
                     <a title="获取一个服务器API令牌" data-ga-label="Page link 1" class="mt-lp-page-link internal" href="//www.sabbathabali.com/success/Integrations/API/Authorization_Tokens/Get_a_Server_API_Token?mt-learningpath=integrations-server" rel="internal"><span class="mt-icon-article-howto"></span>获取一个服务器API令牌</a>
                    </dt>
                    <dd class="mt-listing-detailed-overview mt-lp-page-overview">
                     生成服务器API令牌来集成MindTouch与您的服务器或后端应用程序。</dd>
                   </dl></li>
                  <li class="mt-icon-lp-page">
                   <dl class="mt-listing-detailed">
                    <dt class="mt-listing-detailed-title">
                     <a title="使用具有集成的服务器API令牌" data-ga-label="Page link 2" class="mt-lp-page-link internal" href="//www.sabbathabali.com/success/Integrations/API/Authorization_Tokens/Use_a_Server_API_Token_With_an_Integration?mt-learningpath=integrations-server" rel="internal"><span class="mt-icon-article-howto"></span>使用具有集成的服务器API令牌</a>
                    </dt>
                    <dd class="mt-listing-detailed-overview mt-lp-page-overview">
                     验证服务器API令牌以获得MindTouch API访问的说明和示例。</dd>
                   </dl></li>
                 </ul>
                </div>
               </dd>
              </dl>
             </div>
            </div>
           </div>
          </div>
         </div>
        </div>
        <div mt-section-origin="Integrations/API/000_Getting_Started_With_the_API" class="mt-section" id="section_11">
         <span id="OAuth_API_Token"></span>
         <h3 id="OAuth_API_Token-15657">OAuth API令牌</h3>
         <div class="mt-contentreuse-widget" data-page="Integrations/API/Types_of_Tokens" data-section="OAuth API Token" data-show="false">
          <div class="mt-include" id="s14732">
           <p>虽然Server API令牌提供了一个具有无限权限的MindTouch API的开发人员,但在某些情况下,此类访问控制级别不适合开发人员。示例包括MindTouch API和第三方服务之间的集成,代表部署MindTouch的组织。通过实施<a title="OAuth 2.0授权流程" href="https://www.oauth.com/" target="_blank" rel="external noopener nofollow" class="link-https">OAuth 2.0授权流程</a>, OAuth API令牌允许MindTouch用户授权哪些应用程序或设备可以访问他们的MindTouch用户身份,并允许操作,如读取和写入内容。OAuth API令牌可以安全地交给第三方开发者,而无需担心移交MindTouch网站管理员权限。</p>
           <div class="mt-learningpath-widget" data-path-name="integrations-oauth" data-show-pages="true">
            <div class="mt-lp-path-container mt-lp-path-container-integrations-oauth " data-lp-name="integrations-oauth" data-ga-action="Learning path view">
             <div class="mt-toggle mt-toggle-container mt-lp-pages-container f-lp-pages-container" data-ga-label="Toggle" data-title="View pages">
              <dl class="mt-listing-detailed">
               <dt class="mt-listing-detailed-title">
                <a title="授权OAuth 2.0与MindTouch API的集成" data-ga-label="Learning path link" class="internal" href="//www.sabbathabali.com/success/@go/path/integrations-oauth" rel="nofollow"><span class="mt-icon-article-lp"></span>授权OAuth 2.0与MindTouch API的集成</a>
               </dt>
               <dd class="mt-listing-detailed-overview">
                将MindTouch用户与服务器应用程序、物联网设备、机器人或任何可以使用行业标准授权框架通过HTTPS进行通信的东西集成。</dd>
               <dd class="mt-listing-detailed-pagecount">
                <span>页面:</span>2</dd>
               <dd class="mt-listing-detailed-subpages">
                <div class="mt-collapsible-section">
                 <ul class="mt-lp-page-listings mt-guide-listings" id="lp-pages-106">
                  <li class="mt-icon-lp-page">
                   <dl class="mt-listing-detailed">
                    <dt class="mt-listing-detailed-title">
                     <a title="获取一个OAuth API令牌" data-ga-label="Page link 1" class="mt-lp-page-link internal" href="//www.sabbathabali.com/success/Integrations/API/Authorization_Tokens/Get_an_OAuth_API_Token?mt-learningpath=integrations-oauth" rel="internal"><span class="mt-icon-article-howto"></span>获取一个OAuth API令牌</a>
                    </dt>
                    <dd class="mt-listing-detailed-overview mt-lp-page-overview">
                     生成OAuth API令牌,以集成MindTouch用户与您的服务器或后端应用程序。</dd>
                   </dl></li>
                  <li class="mt-icon-lp-page">
                   <dl class="mt-listing-detailed">
                    <dt class="mt-listing-detailed-title">
                     <a title="使用集成OAuth API令牌" data-ga-label="Page link 2" class="mt-lp-page-link internal" href="//www.sabbathabali.com/success/Integrations/API/Authorization_Tokens/Use_an_OAuth_API_Token_With_an_Integration?mt-learningpath=integrations-oauth" rel="internal"><span class="mt-icon-article-howto"></span>使用集成OAuth API令牌</a>
                    </dt>
                    <dd class="mt-listing-detailed-overview mt-lp-page-overview">
                     使用OAuth API令牌来请求用户授权访问MindTouch API的说明。</dd>
                   </dl></li>
                 </ul>
                </div>
               </dd>
              </dl>
             </div>
            </div>
           </div>
          </div>
         </div>
        </div>
       </div>
       <span id="4974d5ca991c1df64ee1bfda893b15f3"></span>
       <span id="Core_Resources_2"></span>
       <h2>核心资源</h2>
       <div class="mt-include" id="s16358">
        <p>MindTouch API核心资源是非常常见的平台对象,比如页面、文件、用户和组。这些核心资源出现在跨许多不同API端点的请求和响应HTTP消息中。这些资源的一致XML和JSON数据表示允许API集成包含可重用代码来处理这些数据。</p>
        <div class="mt-warning-container style-wrap" title="Warning">
         <p>并不是所有可能的API资源都被认为是核心资源。一些API端点接受并返回在更广泛的API端点集合中不常见的资源数据。</p>
        </div>
       </div>
       <div class="mt-include" id="s16362">
        <span id="Page"></span>
        <h3 id="Page-16362">页</h3>
        <div class="mt-page-summary">
         <div class="mt-page-overview">
          页面资源是MindTouch API中最常见的资源。</div>
        </div>
        <div mt-section-origin="Integrations/API/Core_Resources/Page" class="mt-section" id="section_1">
         <span id="Page_Types"></span>
         <h4 id="Page_Types-16362">页面类型</h4>
         <div mt-section-origin="Integrations/API/Core_Resources/Page" class="mt-section" id="section_2">
          <span id="Existing_Page"></span>
          <h5 id="Existing_Page-16362">现有页面</h5>
          <p>现有的页,包括内容作为草稿准备的未发布页,以及尚未从存档中清除的已删除页,都是在<a class="F1" title="页面层次结构" href="//www.sabbathabali.com/success/Manage/Organize/Structure/Information_Architecture_in_MindTouch" rel="internal">页面层次结构</a>.页面包括所有<a title="导游内容框架" href="//www.sabbathabali.com/success/Manage/Organize/Structure/Guided_content_framework" rel="internal">导游内容框架</a>文章类型,如类别、指南、主题和引用。</p>
          <pre class="brush: xml; collapse: false; first-line: 1; gutter: true; ruler: false; toolbar: true; wrap-lines: true; "><页面id = " {id} " guid = " {guid} " draft.state = "{草案。州}" href = " https://{主机名}/ @api / . . /页面/ {id} ?Redirects =0" deleted="{deleted}" revision="{revision"> <uri.ui>https://{hostname}/{path}</uri. uiUi > <title>{title}
 {path} {namespace} {date.created}语言创造了> < >{语言}< /语言> < /页>
虚拟页

虚拟页面是页面层次结构中尚未创建页面的占位符位置。

  https:// {hostname} / {path}   {title} </ title> <path seo =“{seo}”> {path} </ path> <namespace> {namespace} </ namespace> <date.created> 1970-01-01t00:00:00z </date.created> <language> {language} </ language> {security} {page.parent} </ page></pre>
         </div>
         <div mt-section-origin="Integrations/API/Core_Resources/Page" class="mt-section" id="section_4">
          <span id="Redirect_Page"></span>
          <h5 id="Redirect_Page-16362">重定向页面</h5>
          <p>重定向页面是现有页面,该页面指向页面层次结构或外部URL中的不同页面。</p>
          <pre class="brush: xml; collapse: false; first-line: 1; gutter: true; ruler: false; toolbar: true; wrap-lines: true; "><页面id = " {id} " guid =“00000000000000000000000000000000”重定向= " true "。状态= "活动" href = " https://{主机名}/ @api / . . /页面/ {id} ?Redirects =0" deleted="false" revision="{revision}" type="{page/@type}"> <uri.ui>https://{hostname}/{path}</uri. ui "ui> <title>{title}
 {path} {namespace} 1970-01-01 t00: 00:00:00 z  <语言>{语言}< /语言> < !——页面。当page/@type = "internal-redirect"——> {redirectedto} < !——uri。当page/@type = "external-redirect"——> {uri. Redirectedto} < / >

页面数据

名称 类型 描述
{ID} 本地页面ID - 如果页面将导出并导入不同的MindTouch网站,将分配新的本地页面ID
{guid} 一串 全局页面id——如果页面被导出和导入到不同的MindTouch站点,相同的全局页面id将被保留
{draft.state} {活跃,不活跃,未发表的} 页面是否有活动或未发表的草稿?
{主机名} 一串 MindTouch网站主机名
{删除} 布尔 页面是否已删除并在存档中?
{修订} 页面修订
{页面/ @ type} {内部重定向,外部重定向} 页面是否重定向到页面层次结构中的外部URL或现有页面
{标题} 一串 页面显示标题
{seo} 布尔 页面URL搜索引擎是否优化?
{path} 一串 页面URL路径
{命名空间} {主要,模板} 页面是在模板目录中,还是在页面层次结构中主页的子页面?
{创建日期} 约会时间 页面创建时间戳的ISO 8601表示形式
{语} 一串 页面(站点)语言
{page.parent} 作为页面层次结构中的直接父级的页面 - {PAGE.PARENT}也可以包含其自己的{PAP.PARENT}资源,具体取决于其页面层次结构中的位置
{安全性} 安全 允许的操作和为页面分配的权限
{page.redirectedto} 页面URL将重定向到的现有页面
{uri.redirectedto} uri 页面URL将重定向到的外部URL

检索页面

本地页面ID或全局页面ID(GUID)可用于从MindTouch API检索页面资源数据。它们还可用于创建解析和重定向到MindTouch用户界面中页面内容的链接。

此示例HTML将创建与KCS方法指南的上下文帮助链接。将鼠标悬停在链接上以查看目标页面ID或GUID。

遵循此页面id

按照此页面GUID

<!——使用本地页面id解析并重定向到页面——> ——使用页面guid解析并重定向到页面——> 

安全

安全资源代表管理页面,用户,文件和其他资源的安全性的权限,隐私和角色。

有关安全性、权限、隐私和角色管理的更多详细信息,请参见内容和网站管理主题:

安全类型

页面安全
 {permissions.efcective} {permissions.page}   {permissions}  {date.modified}  {user.modifiedby} <! - 如果在此安全节点管理的资源上分配了一个角色,则可以使用组 - 组可用 - > {组} <! -如果已在此安全节点管理的资源上为用户分配角色 - > {User}  <! - 多个用户或组权限(授予节点),则可用用户可用的是,支持 - > ... {permissions.revoked} 
权限
<权限>  {操作}  <! - 如果通过页面隐私计算权限,则可用限制:<限制ID =“{限制/ @ id}”>{限制}  <! - 如果通过将角色分配给资源上的用户或组在资源上的角色或组中计算权限 - > <角色id =“{角色/ @ id}”href =“https:// {hostname} / @ api / deki / site /角色/ {角色/ @ id}“> {角色}  

安全数据

名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{pageid} 本地页面ID - 如果页面将导出并导入不同的MindTouch网站,将分配新的本地页面ID
{权限。过滤} 权限 从页面,用户和组权限计算的有效权限
{permissions.page} 权限 从分配的限制(页面隐私)计算出的页面权限
{权限} 权限 用户和组权限,由资源上分配给用户和组的角色计算
{面具} 允许或撤销的操作,用一个位序列表示
{操作} 一串 允许或撤销的操作
/ @ id}{限制 限制(页面隐私)ID
{限制} {Public, Private, Semi-Public, Semi-Private} 限制(页面隐私)类型
{角色/ @ id} 角色id
{角色} 一串 角色名称
{date.modified} 约会时间 ISO 8601表示上次安全修改时间戳的表示
{用户} 用户 在资源上分配角色的用户
{组} 在资源上分配角色的组

用户

用户资源代表MindTouch中的用户,包括社区成员、作者和管理员。
 {username} {username} {fullname} {email}   {license.seat} < /许可证。座位> < date.created > {date.created} < /日期。创建> <地位>{地位}< /状态> < date.lastlogin > {date.lastlogin} < /日期。lastlogin > < hash.email > {hash.email} < /散列。电子邮件> < uri.gravatar > {uri.avatar} < / uri。功能> < uri.avatar > {uri.avatar} < / uri。《阿凡达》> < / user >
名称 类型 描述
{ID} 本地用户id
{guid} 一串 全局用户ID
{主机名} 一串 MindTouch网站主机名
{匿名} 布尔 用户是否是匿名用户(未登录)?
{用户名} 一串 用户登录名称
{fullname} 一串 用户的显示名称
{email} 一串 用户的电子邮件地址
{password / @存在} 布尔 用户是否有密码集?
{license.seat/@owner} 布尔 用户是站点所有者吗?
{license.seat} 布尔 用户是专业会员吗?
{创建日期} 约会时间 ISO 8601表示用户帐户的创建时间戳
{date.lastlogin} 约会时间 用户最后一次登录的ISO 8601表示
{地位} 布尔 用户是否处于活动状态并能够登录?
{hash.email} 一串 用户电子邮件地址的MD5表示
{uri.avatar} uri 一个网址功能,映射到用户的电子邮件地址

组资源表示用于报告需求或内容访问控制的用户集合。
{name}{permissions.group}
名称 类型 描述
{ID} 本地组id
{guid} 一串 全球组id
{主机名} 一串 MindTouch网站主机名
{名称} 一串 组的名字
{authid} 标识提供者服务id
{users.count} 属于该组的用户总数
{permissions.group} 权限 分配给组的角色

财产

  {contents}  {date.modified} {user.modified} 
名称 类型 描述
{修订} 物业修订
{ID} 本地属性id -如果属性被导出并导入到不同的MindTouch站点,一个新的本地属性id将被分配
{名称} 一串 属性名称(例如:urn: custom.www.sabbathabali.com css)Mindtouch平台依赖的必需属性通常以结尾的命名空间为前缀符号(例:urn: ui.deki.www.sabbathabali.com #)
{主机名} 一串 MindTouch网站主机名
{资源} 一串 此属性分配给的父资源(可用:用户, 地点)
{etag} 一串 最后一次属性修改的校验和。在修改属性时可以提供etag,以防止不同步的修订编辑冲突
{删除} 布尔 这个属性删除了吗?
{修订已删除} 布尔 这个特定的属性修改被删除了吗?
{mimetype} 一串 属性内容类型(默认值:文本/平原)
{大小} 属性内容大小(字节)
{内容} 一串 属性内容的文本表示形式的预览。如果属性大于2048字节,则必须使用contents/@href URI加载属性content
{date.modified} 约会时间 属性创建或最后修改时间戳的ISO 8601表示
{user.modified} 用户 创建或最后修改属性的用户


行为和内容分析

API端点,用于将用户行为和内容健康数据集成到报告系统中

搜索分析数据

为权力提供权力的分析数据搜索洞察报告搜索条款和查询报告可以通过API端点导出数据以进行进一步分析。

端点

站点结构分析数据

为权力提供权力的分析数据网站结构分析报告提供维持健康的网站内容结构的洞察力。

端点

检索搜索条款和查询

适用于:
所有MindTouch版本
需要的角色:
管理
得到 / @ api / deki / site / secure /查询/日志
卷曲
$ curl -request get  -  header'deki-token:{signature}'https:// {hostname} / / @ api / deki / site / secure / log
javascript.
fetch(“https://{主机名}/ @api / . . /网站/查询/日志? dream.out。format=json', {method: 'GET', headers: {'X-Deki-Token': '{signature}'}}).then((response) => {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{询问}(可选) 字符串? 使用给定的查询词字符串查找搜索(覆盖'term')
{术语}(可选) 字符串? 查找包含特定术语的搜索
{groupby}(可选) {查询}? 按查询聚合
{userid}(可选) 字符串? 只返回用户的结果(允许:由当前用户过滤的整数用户id或'current')(默认:所有用户的结果)
{低质量}(可选) BOOL? 查找有0或超过3个结果的搜索
{自从}(可选) 字符串? 结果集开始日期(格式:'yyyymmddhhmmss')(默认:一个月前)
{前}(可选) 字符串? 结果集的结束日期(格式:'yyyyMMddHHmmss')(默认:现在)
{极限}(可选) int ? 要检索的最大条目数。必须为正数(默认为25)
{抵消}(可选) int ? 跳过的项目数(允许:正数或0以不跳过任何)(默认值:0)
{数数}(可选) int ? 跳过的项目数(允许:正数或0以不跳过任何)(默认值:0)
{getcount}(可选) BOOL? 添加总计数(默认值:true)

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
  {query}…> < /查询
名称 类型 描述
{查询计数} 跟踪的搜索查询总数
{数数} 跟踪搜索查询的计数
{询问} 搜索查询 跟踪的搜索查询


检索所有可用的搜索查询日志名称

适用于:
MindTouch(当前)
需要的角色:
管理
得到 / @api / . . /网站/查询/日志
卷曲
X-Deki-Token: {signature}' https://{hostname}/@api/deki/site/query/logs
javascript.
fetch(“https://{主机名}/ @api / . . /网站/查询/日志? dream.out。format=json', {method: 'GET', headers: {'X-Deki-Token': '{signature}'}}).then((response) => {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
 <! - 支持多个搜索查询日志 - >   {logname}  <修改> {修改后}  <月> {月}   ... 
名称 类型 描述
{完全的} 布尔 是当前月份的搜索查询日志数据
{logname} 一串 日志名称(在检索搜索查询日志下载URL时包含)
{修改} 约会时间 ISO 8601表示搜索查询日志的最后一个修改时间戳
{月} 约会时间 搜索查询日志月份的ISO 8601表示


检索搜索查询日志下载URL

适用于:
MindTouch(当前)
需要的角色:
管理
得到 / @api / . . /网站/查询/ logs / {logname} / url
卷曲
$ curl -request get  -  header'x-deki-token:{signature}'https:// {hostname} / @ api / deki / site / query / logs / {logname} / url
javascript.
fetch(“https://{主机名}/ @api / . . /网站/查询/日志/ {logname} / url ? dream.out。format=json', {method: 'GET', headers: {'X-Deki-Token': '{signature}'}}).then((response) => {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{logname} 一串 要检索URL的日志的名称

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
{url}
名称 类型 描述
{url} uri CSV格式搜索查询日志的下载地址。下载的文件可能需要解压缩。
搜索查询日志
类型 描述
日期 时间戳

格式:yyyy-mm-dd hh: mm: ss
时钟:24小时
时区:UTC

排序条件 一串 所有的单词都在原始查询按字母顺序排序。
原始查询 一串 用户输入的搜索查询。
用户身份 数字 与输入查询的用户相关联的唯一用户标识符。
结果统计 数字 为指定查询返回的结果数。
职位点击了 数字 单击搜索结果列表中的项目的位置。
结果类型 一串 结果类型(例如,页面,文件)。
结果页面路径 一串 单击结果所在路径,格式为“xxx/xxx/xxx/…”
结果页ID. 数字 唯一页面标识符。

检索搜索词和查询细节

适用于:
所有MindTouch版本
需要的角色:
管理
得到 / @ api / deki / site / query / log / {queryid}
卷曲
X-Deki-Token: {signature}' https://{hostname}/@api/deki/site/query/log/{queryid}?queryid={queryid}
javascript.
fetch('https:// {hostname} / @ api / deki / site / query / log / {queryid}?dream.out.format = json&queryid = {queryid}',{method:'get',标题:{''x-deki-token':'{signature}'}})。然后((响应)=> {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{queryid} 一串 唯一查询ID或聚合,排序的QueryString以= =
{自从}(可选) 字符串? 基于querystring的聚合的开始日期(格式:“yyyyMMddHHmmss”)(默认值:一个月前)
{前}(可选) 字符串? 基于QueryString的聚合的结束日期(格式:'yyyymmddhhmmss')(默认值:现在)
{getcount}(可选) BOOL? 添加总计数(默认值:true)

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
搜索查询
<查询id =“{queryid}”href =“https:// {hostname} / @ api / deki / site / query / log / {queryid}”>  {date.searched}  <排序术语> {排序术语}   {raw}   {count.results}  <术语> <! -- 支持多个搜索项 - > <术语> {术语}  ...   <! - 多个选定的结果被支持 - > <结果类型=“{结果/ @类型}”> <位置> {结果/位置}  <等级> {结果/等级}   {结果/date.selected}    ...  
名称 类型 描述
{queryid} 唯一搜索查询ID以进行跟踪
{主机名} 一串 MindTouch网站主机名
{date.searched} 约会时间 执行搜索查询的ISO 8601表示形式
{sorted-术语} 一串 搜索词列表标准化和按字母顺序排序
{生的} 一串 未应用处理的原始搜索查询
{count.results} 匹配结果的总计数
{术语} 一串 单个搜索词
{所选结果/@count} 作为搜索查询所选择的搜索结果计数
{结果/ @类型} {页面,推荐,文件} 搜索结果类型
{} /位置 搜索结果在所有结果(包括推荐的搜索结果)中的位置
{结果/等级} 搜索引擎的搜索结果的加权排名(0到1之间)
{结果/页面/ @ id} 本地页面ID - 如果页面将导出并导入不同的MindTouch网站,将分配新的本地页面ID


检索搜索条件

适用于:
所有MindTouch版本
需要的角色:
管理
得到 / @api / . . /网站/查询/日志/条款
卷曲
X-Deki-Token: {signature}' https://{hostname}/@api/deki/site/query/log/terms . log (X-Deki-Token: {signature}
javascript.
fetch('https:// {hostname} /@api/deki/site/query/log/terms?dream.out.format=json',{方法:'get',标题:{'x-deki-token':'{signature}'}})。然后((响应)=> {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{低质量}(可选) BOOL? 查找具有0个或多于1个结果的搜索
{自从}(可选) 字符串? 结果集开始日期(格式:'yyyymmddhhmmss')(默认:一个月前)
{前}(可选) 字符串? 结果集的结束日期(格式:'yyyyMMddHHmmss')(默认:现在)
{极限}(可选) int ? 要检索的最大项目数(允许:正数)(默认值:25)
{抵消}(可选) int ? 跳过的项目数(允许:正数或0以不跳过任何)(默认值:0)

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
<术语count =“{count}”querycount =“{querycount}”> <! - 支持多个搜索项 - > <术语count =“{hits}”> {term}  ... 
名称 类型 描述
{查询计数} 搜索条件的总计数
{数数} 响应的搜索词的计数
{术语} 一串 单个搜索词
{点击数} 结果的总计数


检索搜索分析

适用于:
MindTouch(当前)
需要的角色:
管理
得到 / @ API / DEKI /网站/搜索/分析
卷曲
$ curl——request GET——header 'X-Deki-Token: {signature}' https://{hostname}/@api/deki/site/search/analytics
javascript.
fetch('https:// {hostname} / @api/deki/site/search/analytics?dream.out.format=json',{方法:'get',标题:{'x-deki-token':'{signature}'}})。然后((响应)=> {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{开始}(可选) 字符串? 开始范围日期(格式:“yyyyMMddHHmmss”)(默认值:一个月前)
{结尾}(可选) 字符串? 结束范围日期(格式:yyyyMMddHHmmss)(默认:现在)
{桶}(可选) 字符串? 时间段桶大小(允许:小时,一天,周,月,季度,年)(默认:月份)
{Userfilter}(可选) 字符串? 用户过滤器适用于数据(允许:None,Pro,Anonymous,Community,AnonymousorCommunity,CommunityOrpro)(默认值:无)
{queryfilters}(可选) 字符串? 逗号分隔的搜索字母过滤器列表适用于数据(例如:foo,bar)(默认值:无)
{web_widget_embed_id}(可选) 字符串? 通过web小部件嵌入代码id过滤数据
{originfilter}(可选) 字符串? 通过原点过滤数据(允许:MT-Web,MT-SFDC,MT-Zendesk)
{排序方式}(可选) 字符串? 排序数据(允许:搜索,单击,结果,日期,位置,Clickspersearch)(默认:搜索)
{排序}(可选) 字符串? 排序要与SortBy一起使用的方向(允许:ASC,DESC)(默认值:DESC)
{recommendedfocusfilter}(可选) BOOL? 将负面情绪分析过滤器应用于数据(默认值:假)
{极限}(可选) int ? 返回的结果数量(允许:1 - 1000)(默认值:100)
{groupids}(可选) 字符串? 用逗号分隔的组id过滤器列表应用于数据(例如:100,101,202)

回复

响应主体媒体类型为 application / json;charset = UTF-8
{“流行”:{“搜索”:[//支持多个搜索查询{“averageclicksearchsearch”:“{平均点击}”,“{平均位置}”,“命中”{hits}“,”Mostecent“:”{MOST-MOST-MOTER-MOST-}“,”查询“:”{查询}“,”结果“:”{COUNT.RESULTS}“,”总“:”{COUNT.TOTAL}“,”TOPRESULT“:{”@type“:”{顶部结果/ @ type}“,”@hits“”{top-结果/ @ hits}“,”页面“:{top-suckers / page}}} ...]},“卷”:{卷}}
名称 类型 描述
{平均点击} 双倍的 搜索查询的平均点击次数
{平均位置} 双倍的 当与提供的搜索词匹配时,点击搜索结果的平均位置
{点击数} 搜索结果的总计数点击
用于{} 约会时间 RFC 1123表示最新点击时间戳的表示
{询问} 一串 搜索查询
{count.results} 匹配结果总数
{count.total} 执行搜索查询的总次数
{顶部结果/ @ type} {页面,推荐,文件} 最单击的搜索结果类型
{最大结果/ @hits} 点击最多的搜索结果总数单击
{最热门结果/页面} 点击次数最多的搜索结果
{卷} 搜索分析卷 搜索分析数据的历史数量
搜索分析卷
{“clicktotal”:“{clicks}”,“单击roughrate”:“{click-tave-rate}”,“point”:[//多个点(按日期分组的点击)被支持{“clicks”:“{point/ clicks}“,”日期“:”{point / date}“,”searchesclicked“:”{point / searchesclicked}“,”total“:”{point / total}“} ......],”searchtotal“:“{searches}”,“searchesclickedtotal”:“{search-clicked}”}
名称 类型 描述
{点击} 单击搜索结果的总计数
{点击通过率} 双倍的 平均点击速率
{搜索} 搜索查询的总计数
{搜索键点} 单击结果结果的总次数
{点/点击} 一天内被点击的搜索结果总数
{点/日期} 约会时间 RFC 1123当天的表示表示分组
{点/ searchesClicked} 单击搜索结果的一天的总次数
{点/总} 一天的搜索查询总数


检索搜索词的详细搜索分析

适用于:
MindTouch(当前)
需要的角色:
管理
得到 / @api / . . /网站/搜索/分析/查询
卷曲
$ curl——request GET——header 'X-Deki-Token: {signature}' https://{hostname}/@api/deki/site/search/analytics/query?
javascript.
fetch('https:// {hostname} /@api/deki/site/search/analytics/query?dream.out.format=json&query= {query}',{方法:'get',标题:{'x-deki-token':'{signature}'}})。然后((响应)=> {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{开始}(可选) 字符串? 开始范围日期(格式:“yyyyMMddHHmmss”)(默认值:一个月前)
{结尾}(可选) 字符串? 结束范围日期(格式:yyyyMMddHHmmss)(默认:现在)
{询问} 一串 搜索术语以生成分析
{桶}(可选) 字符串? 时间段桶大小(允许:小时,一天,周,月,季度,年)(默认:月份)
{Userfilter}(可选) 字符串? 用户过滤器适用于数据(允许:None,Pro,Anonymous,Community,AnonymousorCommunity,CommunityOrpro)(默认值:无)
{web_widget_embed_id}(可选) 字符串? 通过web小部件嵌入代码id过滤数据
{originfilter}(可选) 字符串? 通过原点过滤数据(允许:MT-Web,MT-SFDC,MT-Zendesk)
{排序方式}(可选) 字符串? 排序数据(允许:搜索,单击,结果,日期,位置,Clickspersearch)(默认:搜索)
{排序}(可选) 字符串? 排序要与SortBy一起使用的方向(允许:ASC,DESC)(默认值:DESC)
{recommendedfocusfilter}(可选) BOOL? 将负面情绪分析过滤器应用于数据(默认值:假)
{极限}(可选) int ? 返回的结果数量(允许:1 - 1000)(默认值:100)
{groupids}(可选) 字符串? 用逗号分隔的组id过滤器列表应用于数据(例如:100,101,202)

回复

响应主体媒体类型为 application / json;charset = UTF-8
{//“Clicks”是一个空字符串类型,如果没有搜索结果单击录制“Clicks”:[//多个搜索结果,则支持“单击”:{“ChallandPosition”:“{平均位置}”,“点击“:”{hits}“,”mostecent“:”{more-test-notel-}“,”页面“:{page},”type“:”{type}“} ...},”卷“:{卷}}
名称 类型 描述
{平均位置} 双倍的 只要它匹配就会提供单击搜索结果的平均位置即可提供搜索查询
{点击数} 搜索结果的总计数点击
用于{} 约会时间 RFC 1123表示最新点击时间戳的表示
{页面} 搜索结果
{类型} {页面,推荐,文件} 搜索结果类型
{卷} 搜索分析卷 提供的搜索查询的搜索分析数据的历史量


检索页面健康检查

适用于:
MindTouch(当前)
需要的角色:
作者
得到 / @ api / deki / pages / {pageid} /健康
卷曲
$ curl --request get  -  header'x-deki-token:{signature}'https:// {hostname} / @ api / deki / pages / {pageid} /health?dream.out.format=json&limit= {限制}&offset = {offset}
javascript.
fetch('https:// {hostname} / @ api / deki / pages / {pageid} /health?dream.out.format=json&limit= {limar}&offset = {opetset}',{方法:'get',标题:{'x-deki-token':'{signature}'}})。然后((response)=> {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{分析仪}(可选) 字符串? 要包含的以逗号分隔的分析程序列表(默认:所有分析程序)
{严重性}(可选) 字符串? 报告中包含的以逗号分隔的严重级别列表(允许:warning, info, error)(默认:所有错误级别)
{子页}(可选) BOOL? 包括子页面(默认值:false)
{极限} 返回的最大结果数(默认值:100)
{抵消} 要跳过的项数(默认值:0)

回复

响应主体媒体类型为 application / json;charset = UTF-8
{“count”:“{count}”,//“检查”是一个列表,如果返回多个检查,或单个检查对象“检查”:[//支持多个检查{检查} ...],“querycount“:”{querycount}“}
名称 类型 描述
{查询计数} 提取的检查总数
{数数} 回应中检查的计数
{检查} 检查 一系列检查中的一次检查
检查
{“@severity”:“{严重性}”,“@type”:“{}型”,“消息”:“{消息}”,“页面”:{“@uri”:“{uri}”,“@ id”:“{id}”、“文章”:”{文章}}}
名称 类型 描述
{严重性} 严重程度 检查的严肃性
{分析仪} 分析仪 检查分析仪
{信息} 一串 检查和潜在纠正措施的描述
{uri} uri 页面位置URI
{ID} 本地页面ID - 如果页面将导出并导入不同的MindTouch网站,将分配新的本地页面ID
{}条(可选) 字符串? 页文章类型
严重程度
名称 描述
错误 检查位于页面的问题,这些问题导致破坏经验
信息 检查严格是信息性的,或者在页面中找到了提供更好体验的机会
警告 检查发现了导致糟糕体验的页面问题
分析仪
名称 描述
有条件的内容 列出页面上条件内容的实例
Dekiscript. 检查页面上的DekiScript编程错误
HTTP引用 检查页面上的不安全链接(非HTTPS)
权限 列出页面上设置的用户特定权限(组权限是首选)
结构 验证引导内容框架页面层次结构兼容性的页面
模板 验证页面的指导内容框架页面内容的兼容性


下载条件内容报告

适用于:
MindTouch(当前)
需要的角色:
管理
得到 /@api/deki/site/reports/conditionalcontent.csv.
卷曲
$curl--request GET--header'X-Deki-Token:{signature}'https://{hostname}/@api/Deki/site/reports/conditionalcontent.csv
javascript.
fetch('https:// {hostname} /@api/deki/site/reports/conditionalcontent.csv?dream.out.format=json',{方法:'get',标题:{'x-deki-token':'{signature}'}})。然后((响应)=> {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{严重性}(可选) 字符串? 报告中包含的以逗号分隔的严重级别列表(允许:warning, info, error)(默认:所有错误级别)

回复

响应主体媒体类型为 文字/ CSV;charset = UTF-8
类型 描述
地位 一串 页面位置是否有条件内容存在问题?
  • 信息:条件内容按预期工作
  • 警告:条件内容块有一个问题,需要注意
地点 一串 页面位置URL
信息 一串 对象的上下文描述地位
表达式 一串 用于为条件内容供电的Dekiscript或编辑器工具栏代码
细节 一串 任何条件内容警告的详细说明


下载站点运行状况检查

适用于:
MindTouch(当前)
需要的角色:
管理
得到 / @api / . . /网站/报告/ health.csv
卷曲
X-Deki-Token: {signature}' https://{hostname}/@api/deki/site/reports/health.csv
javascript.
fetch(“https://{主机名}/ @api / . . /网站/报告/ health.csv ? dream.out。format=json', {method: 'GET', headers: {'X-Deki-Token': '{signature}'}}).then((response) => {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{分析仪}(可选) 字符串? 要包含的以逗号分隔的分析程序列表(默认:所有分析程序)
{严重性}(可选) 字符串? 报告中包含的以逗号分隔的严重级别列表(允许:warning, info, error)(默认:所有错误级别)

回复

响应主体媒体类型为 文字/ CSV;charset = UTF-8
类型 描述
地位 严重程度 检查的严肃性
地点 uri 页面位置URI
信息 一串 检查和潜在纠正措施的描述
分析仪 分析仪 检查分析仪


检索站点健康检查

适用于:
MindTouch(当前)
需要的角色:
管理
得到 / @ API / DEKI /网站/报告/ SiteHealth
卷曲
$ curl -request get  -  header'x-deki-token:{signature}'https:// {hostname} /@api/deki/site/reports/sitehealth?dream.out.format=json&limit= {limary}&offset = {offset}
javascript.
fetch('https://{hostname}/@api/deki/site/reports/sitehealth?dream.out.format=json&limit={limit}&offset={offset}',{method:'GET',headers:{X-deki-Token':{signature}}),然后((response)=>{return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{分析仪}(可选) 字符串? 要包含的以逗号分隔的分析程序列表(默认:所有分析程序)
{严重性}(可选) 字符串? 报告中包含的以逗号分隔的严重级别列表(允许:warning, info, error)(默认:所有错误级别)
{极限} 返回的最大结果数(默认值:100)
{抵消} 要跳过的项数(默认值:0)

回复

响应主体媒体类型为 application / json;charset = UTF-8
{“count”:“{count}”,//“检查”是一个列表,如果返回多个检查,或单个检查对象“检查”:[//支持多个检查{检查} ...],“querycount“:”{querycount}“}
名称 类型 描述
{查询计数} 检查总数
{数数} 回应中检查的计数
{检查} 检查 一系列检查中的一次检查


知识管理

用于内容创建、管理和检索的API端点。

导出和导入内容

许多不同的知识管理用例,例如内容翻译,可以通过使用作业API端点自动导出和导入内容。作业API终结点可以启动内容导入和导出作业、取消和检查正在进行的作业的状态。内容导入和导出作业请求被发送到后台作业队列,以便在计算资源可用于处理作业时进行处理。由于并发内容导入和导出作业在高负载期间可能对系统造成压力,因此作业队列使用以下规则处理任务:

  • 不限于每个MindTouch网站运行的并发内容导出作业的数量,但是,如果在进行内容导入作业时,内容导出作业无法启动
  • 只有一个内容导入作业可以同时运行Per MindTouch网站

已完成的、失败的或已取消的作业可以选择性地触发发送给其中一个的通知电子邮件地址或网络钩

端点

路径

通过融合引导来改善客户体验和学习路径进入客户旅程的任何阶段。

端点

检索现场作业列表

适用于:
MindTouch(当前)
需要的角色:
管理
得到 /@api/deki/站点/作业
卷曲
$ curl -request get  -  header' x-deki-token:{signature}'https:// {hostname} / @ api / deki / site / wombos
javascript.
fetch (' https://{主机名}/ @api / . . /网站/工作? dream.out。format=json', {method: 'GET', headers: {'X-Deki-Token': '{signature}'}}).then((response) => {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
<工作> < !——支持多个作业——> {job}…> < /工作
名称 类型 描述
{工作} 工作 网站工作

检索网站工作

适用于:
MindTouch(当前)
需要的角色:
管理
得到 /@api/deki/site/jobs/{id}
卷曲
$ curl --request get  -  header' x-deki-token:{signature}'https:// {hostname} / @ api / deki / site / wombs / {id}
javascript.
fetch(“https://{主机名}/ @api / . . /网站/工作/ {id} ? dream.out。format=json', {method: 'GET', headers: {'X-Deki-Token': '{signature}'}}).then((response) => {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
工作
<作业ID =“{id}”类型=“{type}”status =“{status}”> <提交> {chupited}   {lastmodified}   {data} <! - 任选地在作业资源是作业提交的结果时可用 - > {用户} 
名称 类型 描述
{ID} 一串 uuid v4格式的此作业的唯一ID
{类型} {导出,导入,import_test} 工作类型
{地位} {提交,in_progress,完成,失败,取消} 工作的地位
{提交} 约会时间 作业提交事件时间戳的ISO 8601表示
{lastmodified} 约会时间 ISO 8601表示上次作业状态已更新时间戳
{数据} XML. 结构化数据(目前未在API规范中记录)
{用户}(可选) 用户 提交作业的用户
作业类型
工作类型 描述
出口 内容导出作业
进口 内容导入作业
import_test 试运行内容导入作业,该作业将只处理导入清单和有关警告和错误的内容,而不创建或更新内容
工作状态
作业状态 描述
提交 作业在队列中,没有在进行中。虽然无法准确预测作业开始的时间,但在正常的系统操作下,我们期望作业在五(5)分钟内开始
进行中 工作正在进行中。一旦正在进行中,一个出口可以取消类型作业,但是一个进口import_test不能取消类型作业
完整的 作业完成后,系统将通知和可选日志发送到配置的email地址或webhook
失败的 作业失败,系统发送通知和错误日志到配置的电子邮件地址或webhook
取消了 作业已被取消,系统将通知和可选日志发送到已配置的电子邮件地址或Webhook

取消提交的网站工作

适用于:
MindTouch(当前)
需要的角色:
管理
邮政 / @api / . . /网站/工作/ {id} /取消
卷曲
$ curl --request post  -  header'deki-token:{signature}'https:// {hostname} / @ api / deki / site /作业/ {id} / cancel --data {body}
javascript.
fetch (' https://{主机名}/ @api / . . /网站/工作/ {id} /取消? dream.out。format=json', {method: 'POST', headers: {'X-Deki-Token': '{signature}'}, body: '{body}'}).then((response) => {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{身体} 应用程序/xml;字符集=utf-8 此端点所需的请求有效负载
身体
请求正文媒体类型是 应用程序/xml;字符集=utf-8

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
{工作}
名称 类型 描述
{工作} 工作 网站工作

安排网站导出工作

适用于:
MindTouch(当前)
需要的角色:
管理
邮政 / @api / . . /网站/工作/出口
卷曲
$ curl --request post  -  header'x-deki-token:{signature}'https:// {hostname} / @ api / deki / site /作业/导出--data {body}
javascript.
fetch('https:// {hostname} /@api/deki/site/jobs/export?dream.out.format=json',{方法:'post',标题:{'x-deki-token':'{签名}'},正文:'{body}'})。然后((响应)=> {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{身体} 应用程序/xml;字符集=utf-8 此端点所需的请求有效负载
身体
请求正文媒体类型是 应用程序/xml;字符集=utf-8
<作业> <通知> <! - 只需要一个通知值:电子邮件或URL  - > <电子邮件> {email}   {url}   <! -- 只需要一个页面,但允许多个页面才能导出多个页面层次结构 - > <页面包括aubpages =“{uppordubpages}”>  {页面/路径}  ... 
名称 类型 描述
{email}(可选) 字符串? 接收通知的电子邮件地址
{url}(可选) 字符串? 接收HTTP POST通知的webhook URL
{upplyubpages}(可选) BOOL? 是否应该导出页面位置的整个子页面层次结构?(默认值:false)
{页面/路径} 一串 要导出的相对页面URL(例如:foo/bar/baz)

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
{工作}
名称 类型 描述
{工作} 工作 网站工作

计划站点导入作业

适用于:
MindTouch(当前)
需要的角色:
管理
邮政 / @api / . . /网站/工作/导入
卷曲
$ curl --request post  -  header' x-deki-token:{signature}'https:// {hostname} / @ api / deki / site / womms / import --data {body}
javascript.
fetch(“https://{主机名}/ @api / . . /网站/工作/进口? dream.out。format=json', {method: 'POST', headers: {'X-Deki-Token': '{signature}'}, body: '{body}'}).then((response) => {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{试运行}(可选) BOOL? 执行导入的干燥运行以诊断潜在内容问题(默认值:False)
{身体} 应用程序/xml;字符集=utf-8 此端点所需的请求有效负载
身体
请求正文媒体类型是 应用程序/xml;字符集=utf-8
<作业> <通知> <! - 只需要一个通知值:电子邮件或URL  - > <电子邮件> {email}   {url}    {archive}   <! - 可选配置 - > <选项> <选项名称=“dryrun”> {dryrun}   
名称 类型 描述
{email}(可选) 字符串? 接收通知的电子邮件地址
{url}(可选) 字符串? 接收HTTP POST通知的webhook URL
{档案} 一串 内容导入存档的公共URL
{试运行}(可选) BOOL? 执行导入的干燥运行以诊断潜在内容问题(默认值:False)

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
{工作}
名称 类型 描述
{工作} 工作 网站工作

设置网站作业状态

适用于:
MindTouch(当前)
需要的角色:
管理
/ @ api / deki / site / wombs / {id} / status / status / {status}
卷曲
$ curl -request put  - 主机'x-deki-token:{signature}'https:// {hostname} / @ api / deki / site /作业/ {id} / status / status / {status} --data {身体}
javascript.
获取('https:// {hostname} / @ api / deki / site / wombs / {id} / status / status / {status}?dream.out.format = json',{方法:'put',标题:{''x-deki-token':'{signature}'},body:'{body}'})。然后((响应)=> {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{身体} 应用程序/xml;字符集=utf-8 此端点所需的请求有效负载
身体
请求正文媒体类型是 应用程序/xml;字符集=utf-8

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
{工作}
名称 类型 描述
{工作} 工作 网站工作

工作通知

已完成,失败或取消的作业可以选择触发要发送到电子邮件地址或Webhook的通知。

电子邮件

电子邮件通知将在收到的消息中包含以下信息:

网钩

一个公共的webhook(没有任何授权要求)可以配置为从MindTouch接收一个带有以下json格式有效负载的HTTP POST消息:

{“@Id”:“{id}”,“@type”:“{type}”,“@status”:“{status}”,“站点”:“{hostname}”,“log”:{“CSV“:”{log}“},”URI“:”{archive}“}
名称 类型 描述
{ID} 一串 uuid v4格式的此作业的唯一ID
{类型} {出口进口} 工作类型
{地位} {已完成,失败,已取消} 工作的地位
{主机名} 一串 作业排队所在的MindTouch站点主机名
{日志}(可选) 一串 下载任何生成的错误或警告日志的URL
{档案}(可选) 一串 如果内容导出作业成功,则输出到要下载的导出内容存档的URL

错误和警告日志

如果内容导入或导出作业失败或被取消,则可以使用错误日志。如果作业成功,但在处理过程中检测到非关键问题,则可能有警告日志。日志格式为CSV,标题行列如下:

标题 描述
dataid. Package.xml文件中引用的数据的唯一确定性ID,它引用了警告或错误(页面,附件,页面权限等)
页路径 数据与数据相关联的相对页面URL
警告类型 错误或警告消息的类型
信息 对错误或警告的解释
消息类型

消息类型值可用警告类型列标题行。

消息类型(警告型) 工作类型 描述
Usergrantsent. 出口 授予用户的页面权限将不会导出或导入
DekiScriptErrorDetected 出口 页面内容包含无效的DekiScript源
nonportablelinkdetected. 出口 页面内容包含到本地文件id的链接(没有文件名)
AnalyzerFailedToRun 出口 无法分析页面内容,以便为出口准备内容
contentparsingerrodettedeted 出口 页面内容导致解析错误,该错误将在日志消息中进一步描述
PageOverviewWithScriptedContentDetected 出口 页面摘要只能是纯文本,不能包含Dekiscript来源
被忽略的探索推荐 出口 与导出的搜索建议相关联的页面不是内容导出清单的一部分
IgnoredContextMappping. 出口 映射到导出的内容ID的页面不是内容导出清单的一部分
失败了 进口 有关导入异常的详细信息,请参阅消息
检测到PageDraft 出口 此页面的草稿将不会出口
IgnoredInvalidLearningPathName 出口 无效的引导路径名(路径名只能包含字母、破折号和连字符)
被忽略的inearningpatpape 出口 与引导路径相关联的页面不是内容导出清单的一部分
IgnoredLearningPathPages 出口 与引导路径相关联的页面不是内容导出清单的一部分
PageCreationConflictsWithExistingPage 进口 导出清单中的页面位置与目标MindTouch站点中的相同位置之间的页面指南不匹配
PageMoveConflictsWithExistingPage 进口 无法移动页面,因为存在具有相同标题的页面已存在
PageMoves与现有PageOutside子层级冲突 进口 为了同步页面层次结构,需要从目的地MindTouch站点页面层次结构的页面移动到目标MindTouch站点页面层次结构中的位置,页面位置已存在于目标
pagemovetargetparentfailedtoimport. 进口 移动目标的父页面失败,所以移动不能继续
跳过页面创建,因为以前的页面被跳过 进口 无法导入页面,因为未导入父页面
SkippingPageCreationBecauseItWasPreviouslyDeleted 进口 在导入时要创建的页面之前删除了目的地MindTouch网站
SkippingPageTagsBecausePagePreviouslySkipped 进口 跳过页面所以还跳过了任何相关资源
SkippingPageFileBecausePagePreviouslySkipped 进口 跳过页面所以还跳过了任何相关资源
skpingpagepropertybecausepage prevearyskipled. 进口 跳过页面所以还跳过了任何相关资源
SkippingFilePropertyBecausePagePreviouslySkipped 进口 跳过页面所以还跳过了任何相关资源
Skooppagepermissionsbecausepagepreveryskified. 进口 跳过页面所以还跳过了任何相关资源
缺少页面导入 进口 页在导出清单中定义,但在存档中缺失

检索学习路径列表

适用于:
MindTouch(当前)
需要的角色:
不适用
得到 / @api / . . /学习进程
卷曲
$ curl——request GET——header 'X-Deki-Token: {signature}' https://{hostname}/@api/deki/learning-paths
javascript.
fetch('https:// {hostname} / @api/deki/learning-paths?dream.out.format=json',{方法:'get',标题:{'x-deki-token':'{签名}'}})。然后((响应)=> {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
  {learning-path}…< /学习>
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{数数} 网站学习路径的总数
{学习路径} 学习途径 网站学习路径的集合之一


检索学习路径

适用于:
MindTouch(当前)
需要的角色:
不适用
得到 / @ api / deki / learning-paths / {pathid}
卷曲
$ curl --request get  -  header'dreki-token:{signature}'https:// {hostname} / @ api / deki / learning-paths / {pathid}
javascript.
fetch(“https://{主机名}/ @api / . . /学习/ {pathid} ? dream.out。format=json', {method: 'GET', headers: {'X-Deki-Token': '{signature}'}}).then((response) => {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{pathid} 一串 前缀为“=”的学习路径id

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
学习途径
 {title}
 {summary} {category} {date.modified}修改了> https://success.www.sabbathabali.com/@go/path/{id}  {page}   . php
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{pathid} 一串 学习路径id
{修订} 学习路径修订
{摘要} 一串 对学习路径及其用途的描述
{类别} 一串 学习路径类别,用于根据组织需要筛选或分组学习路径
{date.modified} 约会时间 ISO 8601表示学习路径的最后更新时间戳
{pages.count} 此学习路径中的总页数
{页面} 页面集合之一,在学习路径中顺序排列


检索学习路径页面

适用于:
MindTouch(当前)
需要的角色:
不适用
得到 / @ API / DEKI /学习路径/ {PATHID} /页面
卷曲
$ curl——request GET——header 'X-Deki-Token: {signature}' https://{hostname}/@api/deki/learning-paths/{pathid}/pages
javascript.
fetch(“https://{主机名}/ @api / . . /学习/ {pathid} /页? dream.out。format=json', {method: 'GET', headers: {'X-Deki-Token': '{signature}'}}).then((response) => {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{pathid} 一串 前缀为“=”的学习路径id

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
 <! - 支持多个页面 - > {页面} ... 
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{pathid} 学习路径id
{页面} 页面集合之一,在学习路径中顺序排列


检索学习路径页面

适用于:
MindTouch(当前)
需要的角色:
不适用
得到 / @api / . . /学习/ {pathid} /页面/ {pageid}
卷曲
$ curl --request get  -  header' x-deki-token:{signature}'https:// {hostname} / @ api / deki / learning-paths / {pathid} / pages / {pupid}
javascript.
fetch (' https://{主机名}/ @api / . . /学习/ {pathid} /页面/ {pageid} ? dream.out。format=json', {method: 'GET', headers: {'X-Deki-Token': '{signature}'}}).then((response) => {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{pathid} 一串 前缀为“=”的学习路径id
{pageid} 一串 无论是整数页面ID,“主页”,“:”后跟一个页面GUID,或“=”,后跟一个双URI编码页面标题

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
{页面}
名称 类型 描述
{页面} 学习路径页面


搜索

用于利用MindTouch搜索引擎的API端点。

智能搜索

智能搜索API端点将搜索体验和搜索分析跟踪扩展到聊天机器人、CRM和物联网设备等新的内容发布渠道。

端点

企业和联合搜索

OpenSearch提供了发布和消耗搜索结果的功能,以常见的格式企业和联合搜索技术。

端点

搜索建议

搜索推荐API端点可以利用以自动化创建,修改和删除搜索结果,当匹配确切搜索项时,定位为顶部结果。

端点

使用分析跟踪搜索站点索引

适用于:
所有MindTouch版本
需要的角色:
不适用
得到 / @api / . . /网站/查询
卷曲
$ curl——request——header 'X-Deki-Token: {signature}' https://{hostname}/@api/deki/site/query?
javascript.
fetch(“https://{主机名}/ @api / . . /网站/查询? dream.out。format=json&q={q}', {method: 'GET', headers: {'X-Deki-Token': '{signature}'}}).then((response) => {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{q} 一串 搜索查询(搜索术语或高级语法)
{Parser}(可选) {最佳|术语| Lucene}? 用于查询的解析器(默认:bestguess)
{notrack}(可选) BOOL? 禁用分析查询跟踪(默认:false)
{queryid}(可选) ulong吗? 查询原始查询结果返回的查询跟踪ID(用于寻呼/更改排序顺序)
{sessionid}(可选) 字符串? 查询跟踪会话ID
{previousqueryid}(可选) ulong吗? 查询以前查询的跟踪ID,如果这是后续查询
{极限}(可选) int ? 要检索的最大项目数(允许:正数)(默认值:25)
{抵消}(可选) int ? 跳过的项目数(允许:正数或0以不跳过任何)(默认值:0)
{排序方式}(可选) {等级,标题,修改}? 排序字段。使用' - '排序下降的前缀值(默认值:-rank)
{约束}(可选) 字符串? 其他搜索约束(例如:language:en-us AND type:wiki)(默认:none)
{paturancestors}(可选) 字符串? 逗号分隔的路径祖先列表以过滤搜索结果。路径中的非划定逗号必须编码(默认值:无)
{标签}(可选) 字符串? 逗号分隔的标签列表用于过滤搜索结果(默认:none)
{分类}(可选) 字符串? 逗号分隔的分类列表以过滤搜索结果(默认值:无)
{类型}(可选) 字符串? 逗号分隔的文档类型列表筛选搜索结果(默认值:无)
{名称}(可选) 字符串? 过滤搜索结果的名称空间(默认:无)
{说明}(可选) BOOL? 包含排名细节(默认值:false)
{IncludeAggs}(可选) BOOL? 包含聚合(默认值:false)
{建议}(可选) BOOL? 包括建议(默认值:true)
{推荐}(可选) 字符串? 逗号分隔的页面ID列表推荐结果(默认值:无)
{signumpath}(可选) 字符串? 计算结果计数摘要的路径(默认值:无)
{aggpath}(可选) 字符串? 计算结果计数摘要的路径(默认值:无)
{metrics}(可选) BOOL? 在结果中包括视图计数和字数计数指标(默认为false)

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
智能搜索结果

这个API端点响应以及API端点请求参数包含必要的信息,以提供经过筛选的、分面搜索体验,并进行搜索分析跟踪。

 < !> …<!>  {id} {uri} {uri.track} <等级>{排名}< /等级> <标题>{标题}< /名称> < !——if {type} = page: page是基于搜索算法最匹配搜索词的内容位置——>   <页面> <评级得分= "{页面/等级/ @score}”数= "{页面/等级/ @count} " / > <标题>{页面/标题}< /名称> <路径>{页面/路径}<路径> / < uri.ui >{页面/ uri。Ui}  {author}   {preview} {preview} {date.modified} <类型>{类型}< /类型> < mime > {mime} < / mime > <标记>{标签}< /标签> < !——if {metric} = true——> {metric.views}视图> < metric.charcount > {metric.charcount} < /指标。结果charcount > < / >…<!——if {includeaggs} = true——>     {aggs/pages/value} {aggs/pages/title}
  ...    {aggs/articles/value}  ...    {aggs/custom_classifications/classification}   {aggs/custom_classifications/value}   ...   
名称 类型 描述
{queryid} 一串 用于跟踪或优化查询的搜索结果的唯一搜索查询id(包含在搜索分析跟踪URL中)
{sessionid} 一串 唯一的搜索会话ID(包含在搜索分析跟踪URL中)
{查询计数} 搜索查询匹配的资源总数(忽略限制和偏移量)
{count.recomencations} 总菌数的推荐的搜索结果
{数数} 搜索查询与请求的限制和偏移量匹配的资源计数
{推荐/@id} 推荐搜索结果的页面ID
{ID} 匹配搜索查询的资源内容的ID
{uri} uri 匹配搜索查询的资源位置URL
{uri.track} uri 当选择或单击搜索结果时请求的搜索分析跟踪信标URL
{秩} 浮动 相对搜索排名排序,从最多相关的最多相关的搜索结果
{标题} 一串 搜索结果显示标题(上下文到资源:页面显示标题或文件名)
{页面/评级/ @得分} 搜索结果页的当前额定值分数
{页面/等级/ @count} 搜索结果页面被评分的次数
{页面标题} 一串 搜索结果页面显示标题
{页面/路径} 一串 搜索结果页层次结构位置
{页面/ uri.ui} 一串 搜索结果页面位置URL
{作者} 一串 最后修改与搜索查询匹配的资源的作者的用户名
{预习} 一串 搜索结果预览内容
{date.modified} 约会时间 ISO 8601资源的最后修改时间戳表示
{类型} {页面,推荐,文件} 搜索结果类型
{哑剧} 一串 资源媒体类型
{标签} 一串 空格分隔列出的搜索结果页面标签,分类和文章类型
{metric.views} 资源视图的总计数
{metric.charcount} 资源内容中的字符总数
{gg /页面/ @count} 位置筛选器选项下的搜索结果数量
{gg /页面/ @ id} 位置过滤器选项的页面ID
{aggs/pages/value} 一串 位置筛选器选项的名称
{aggs / pages / title} 一串 位置过滤器选项的显示标题
{aggs /文章/ @ count} 文章类型过滤器选项下的搜索结果数
{gg /文章/值} 一串 文章类型过滤器选项的名称
{gg / custom_classifications /分类} 一串 自定义分类过滤器选项分类名称
{gg / custom_classifications @count} 自定义分类过滤器选项下的搜索结果数
{gg / custom_classifications /值} 一串 自定义分类筛选器选项分类值

使用OpenSearch搜索站点索引

适用于:
所有MindTouch版本
需要的角色:
不适用
得到 / @ api / deki / site / Opensearch
卷曲
$ curl --request get  -  header'x-deki-token:{signature}'https:// {hostname} / @ api / deki / site / Opensearch?q = {q}
javascript.
fetch(“https://{主机名}/ @api / . . /网站/ opensearch ? dream.out。format=json&q={q}', {method: 'GET', headers: {'X-Deki-Token': '{signature}'}}).then((response) => {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{格式}(可选) {rss |原子}? 搜索输出格式(RSS | ATOM)默认:原子
{q} 一串 搜索条件
{极限}(可选) 字符串? 最大检索项数(允许:一个正数或'all'检索所有项)(默认:100)
{抵消}(可选) int ? 跳过的项目数(允许:正数或0以不跳过任何)(默认值:0)
{排序方式}(可选) {score, title, date, size, wordcount, rating。分数,rating.count} ? 排序字段。使用“ - ”排序下降的前缀值。默认值:-core.
{约束}(可选) 字符串? 其他搜索约束(例如:语言:en-US和类型:Wiki)默认值:无
{paturancestors}(可选) 字符串? 逗号分隔的路径祖先列表过滤搜索结果(默认值:无)
{标签}(可选) 字符串? 逗号分隔的标签列表用于过滤搜索结果(默认:none)
{分类}(可选) 字符串? 逗号分隔的分类列表以过滤搜索结果(默认值:无)
{类型}(可选) 字符串? 逗号分隔的文档类型列表筛选搜索结果(默认值:无)
{名称}(可选) 字符串? 过滤搜索结果的名称空间(默认:无)
{Parser}(可选) lucene} {bestguess | | |术语文件名吗? 用于查询的解析器(默认:bestguess)
{nocache}(可选) BOOL? 使用缓存搜索路径(更好地用于分页结果)(默认值:false)
{引擎}(可选) {lucene}是吗? 搜索引擎(lucene | es)默认:lucene

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
OpenSearch 1.1响应

MindTouch API以标准方式返回OpenSearch数据OpenSearch 1.1 RSS 2.0或Atom 1.0架构的值{格式}请求参数。除了标准模式之外,响应还包括定制的XML元素(XMLNS:mt =“http://services.www.sabbathabali.com/deki/draft/2007/06/luceneindex”).

<{root} xmlns:mt =“http://services.www.sabbathabali.com/deki/draft/2007/06/luceneIndex”> <{结果}>  {path}   {id}  <! - 如果{type} =页面:页面是基于搜索algorithim的最佳搜索项的内容的位置 -> <! - 如果{类型} =文件:页面是文件附件的位置,其中包含基于搜索algorithim  - >   ...
名称 类型 描述
{根} {饲料,rss}
  • 如果{format} = atom,则{root} = feed
  • 如果{format} = RSS,则{root} = RSS
{结果} {条目,条目}
  • 如果{format} = atom,则{结果} =条目
  • 如果{format} = RSS,则{RESULD} =项目
{主机名} 一串 MindTouch网站主机名
{path} 一串 搜索结果页层次结构位置
{类型} {页面,文件} 搜索结果类型
{ID} 匹配搜索查询的资源内容的ID
{页面/ @ id} 页面层次结构的页面ID位置
{标题} 一串 搜索结果页面显示标题

检索OpenSearch描述文档

适用于:
所有MindTouch版本
需要的角色:
不适用
得到 / @ API / DEKI / SINE / OPENSEARCH /描述
卷曲
$ curl --request get  -  header' x-deki-token:{signature}'https:// {hostname} / @ api / deki / site / Opensearch /描述
javascript.
fetch(“https://{主机名}/ @api / . . /网站/ opensearch /描述? dream.out。format=json', {method: 'GET', headers: {'X-Deki-Token': '{signature}'}}).then((response) => {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
OpenSearch 1.1描述

MindTouch API在标准中返回OpenSearch描述数据OpenSearch 1.1描述XML架构.除标准架构外,API端点响应还包括对的引用OpenSearch 1.1建议扩展

  
名称 类型 描述
{uri} uri 返回OpenSearch 1.1建议扩展数据的API端点位置

用OpenSearch搜索网站索引以获得建议

适用于:
所有MindTouch版本
需要的角色:
不适用
得到 / @api / . . /网站/ opensearch /建议
卷曲
$ curl——request GET——header 'X-Deki-Token: {signature}' https://{hostname}/@api/deki/site/opensearch/suggestions?
javascript.
fetch('https:// {hostname} / @api/deki/site/opensearch/sugbestions?dream.out.format=json&q= {q}',{方法:'get',标题:{'x-deki-令牌':'{signature}'}})。然后((响应)=> {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{q} 一串 搜索条件
{排序方式}(可选) {score, title, date, size, wordcount, rating。分数,rating.count} ? 排序字段。使用“ - ”排序下降的前缀值。默认值:-core.
{约束}(可选) 字符串? 其他搜索约束(例如:语言:en-US和类型:Wiki)默认值:无
{paturancestors}(可选) 字符串? 逗号分隔的路径祖先列表过滤搜索结果(默认值:无)
{标签}(可选) 字符串? 逗号分隔的标签列表用于过滤搜索结果(默认:none)
{分类}(可选) 字符串? 逗号分隔的分类列表以过滤搜索结果(默认值:无)
{类型}(可选) 字符串? 逗号分隔的文档类型列表筛选搜索结果(默认值:无)
{名称}(可选) 字符串? 过滤搜索结果的名称空间(默认:无)
{引擎}(可选) {lucene}是吗? 搜索引擎(lucene | es)默认:lucene

回复

响应主体媒体类型为 application / json;charset = UTF-8
OpenSearch 1.1建议

MindTouch API返回OpenSearch建议数据OpenSearch 1.1建议扩展JSON模式


删除搜索推荐

适用于:
所有MindTouch版本
需要的角色:
管理
删除 / @ api / deki / site /查询/建议/ {id}
卷曲
$ curl -request delete  -  header' x-deki-token:{signature}'https:// {hostname} / @ api / deki / site / query / complace / {id}
javascript.
fetch('https:// {hostname} / @ api / deki / site / query / compules / {id}?dream.out.format = json',{方法:'delete',标题:{'x-deki-令牌':'{signature}'}})。然后((响应)=> {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{ID} 按id标识搜索建议

回复

API端点没有用消息正文响应

检索推荐的搜索列表

适用于:
所有MindTouch版本
需要的角色:
管理
得到 / @api / . . /网站/查询/建议
卷曲
$ curl -request get  -  header' x-deki-token:{signature}'https:// {hostname} / @ api / deki / site /查询/建议
javascript.
fetch(“https://{主机名}/ @api / . . /网站/查询/建议? dream.out。format=json', {method: 'GET', headers: {'X-Deki-Token': '{signature}'}}).then((response) => {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{极限}(可选) int ? 要检索的最大项目数(允许:正数)(默认值:25)
{抵消}(可选) int ? 跳过的项目数(允许:正数或0以不跳过任何)(默认值:0)

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
  {recommendation}…> < /建议
名称 类型 描述
{数数} 响应的搜索推荐数
{totalcount} 搜索建议总数(忽略限制和偏移)
{推荐} 搜索推荐 积极的搜索建议


检索搜索推荐

适用于:
所有MindTouch版本
需要的角色:
管理
得到 / @ api / deki / site /查询/建议/ {id}
卷曲
X-Deki-Token: {signature}' https://{hostname}/@api/deki/site/query/recommendations/{id}
javascript.
fetch (' https://{主机名}/ @api / . . /网站/查询/建议/ {id} ? dream.out。format=json', {method: 'GET', headers: {'X-Deki-Token': '{signature}'}}).then((response) => {return response.json();});

要求

►扩展/崩溃
参数
由此端点所需或接受的参数(可选参数可以附加到端点查询字符串)
名称 类型 描述
{主机名} 一串 MindTouch网站主机名
{签名} 一串 API令牌密钥或签名
{ID} 按id标识搜索建议

回复

响应体也可以通过附加来使用JSON格式 dream.out.format = json. 到请求URL
搜索推荐
<推荐id="{id}"> {title}
 {pageid}