公开(public) API

    总述

    Public API 是一组用于暴露在公网上的 API。这组 API,无需权限认证,采用engine_key参数来标识engine。Public API 均为"只读(Readonly)“ API,即:不会改变资源。Public API 包含搜索自动补全两部分。

    搜索

    GET /public/search
    
    POST /public/search
    

    说明

    无需auth_token进行认证,通过engine_key参数指定要进行搜索的engine

    参数和返回格式和搜索 API完全一样。

    示例

    curl -XPOST 'http://api.tinysou.com/v1/public/search' \
      -H 'Content-Type: application/json' \
      -d '{
            "engine_key": "97eaafba26b04d3cdeb9",
            "c": "page",
            "q": "自定义样式",
            "fetch_fields": ["title", "sections", "url"],
            "sort": [
              {"updated_at" : {"order" : "desc"}}
            ],
            "per_page": 100
          }' | json_reformat
    

    自动补全

    GET /public/autocomplete
    
    POST /public/autocomplete
    

    说明

    无需auth_token进行认证,通过engine_key参数指定要进行搜索的engine

    参数和返回格式和自动补全 API完全一样。

    示例

    curl -XPOST 'http://api.tinysou.com/v1/public/autocomplete' \
      -H 'Content-Type: application/json' \
      -d '{
            "engine_key": "97eaafba26b04d3cdeb9",
            "c": "page",
            "q": "自定义样式",
            "fetch_fields": ["title", "sections", "url"],
            "sort": [
              {"updated_at" : {"order" : "desc"}}
            ],
            "per_page": 100
          }' | json_reformat
    

    相关文档

    GET /public/related
    
    POST /public/related
    

    说明

    无需auth_token进行认证,通过engine_key参数指定要进行搜索的engine,通过collection参数指定要进行搜索的collection,通过id参数指定要进行搜索的document

    其他参数和返回格式和相关文档 API完全一样。

    示例

    curl -XPOST 'http://api.tinysou.com/v1/public/related' \
      -H 'Content-Type: application/json' \
      -d '{
            "engine_key": "97eaafba26b04d3cdeb9",
            "collection": "page"
            "id": "5dd4cfc356ef52c895fc01cd451d9efa",
            "fetch_fields": ["title", "sections", "url"],
            "per_page": 100
          }' | json_reformat