VersionUpdate TimeStatusAuthorDescription

v2025-01-08 19:01:08

2025-01-08 19:01:08

auto

@dell

Created by smart-doc

1.跨域标识解析入口

1.1.根据PATH解析标识

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 各种标识的输入如下:{prefix}:{id}
CSTR:15398.11.A00120001
DOI:10.1038/s41586-023-05742-0
PMID:38735402
ORCID:0000-XYZQ-ABCD-EFGH
ORCID:0009-0004-7295-9613
ISLI:000000-000000000000168-8
ISLI:010007-00000013431599999999-7
ISNI:1431 4632 3417 9283
ISNI:0000000014314597
ISBN:978-0-13-601970-1
返回分为:IdDto或当IdDto的data不为空时候返回IndexModel

Path-parameters:

ParameterTypeDescriptionRequiredSince

id

string

查询的标识id信息{标识类型:标识号}

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

index

string

搜索的索引,值为 url或者ids(cstr,doi,pmid等),默认url代表转发

false

-

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids/{id}?index=url' --data '&"url"'

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {}
}

1.2.doi输入匹配

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: DOI:10.1038/s41586-023-05742-0 因为doi的输入是如上所述的格式,所以需要进行特殊处理一下。将其分为doiPrefix(10.1038)和doiSuffix(s41586-023-05742-0)

Path-parameters:

ParameterTypeDescriptionRequiredSince

doiPrefix

string

doi前缀

true

-

doiSuffix

string

doi后缀

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

index

string

搜索的索引,值为 url或者ids(cstr,doi,pmid等),默认url代表转发

false

-

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids/{doiPrefix}/{doiSuffix}?index=url' --data '&"url"'

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {}
}

1.3.复杂doi的输入匹配——双层PATH参数

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 需要更多的处理,比如,双Path参数:10.1093/abbs/gmq008,10.1093/nar/gkq285,10.1155/2022/5477024
这里不定的path层次会给解析带来更多的问题。
doi里面包含更多符号:10.1002/1097-0215(20001201)88:5<692::aid-ijc2>3.0.co;2-3
10.1002/(sici)1096-9896(200001)190:1<61::aid-path502>3.0.co;2-#

Path-parameters:

ParameterTypeDescriptionRequiredSince

doiPrefix

string

doi前缀

true

-

doiSuffix1

string

doi后缀1

true

-

doiSuffix2

string

doi后缀2

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

index

string

搜索的索引,值为 url或者ids(cstr,doi,pmid等),默认url代表转发

false

-

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids/{doiPrefix}/{doiSuffix1}/{doiSuffix2}?index=url' --data '&"url"'

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {}
}

1.4.更通用输入——查询参数传递

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: doi的输入是更复杂,当双层path无法处理,以及更多符号无法处理时候,需要更新处理的模式
doi里面包含更多符号:10.1002/1097-0215(20001201)88:5<692::aid-ijc2>3.0.co;2-3
10.1002/(sici)1096-9896(200001)190:1<61::aid-path502>3.0.co;2-#

Query-parameters:

ParameterTypeDescriptionRequiredSince

index

string

搜索的索引,值为 url或者ids(cstr,doi,pmid等),默认url代表转发

false

-

id

string

标识id信息:规范输入:{标识类型:标识号}

true

-

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids?index=url&id='

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {}
}

2.跨域标识解析返回说明

2.1.IdDto结果说明

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 一般立即返回的数据就是这个,没有去做数网页页面的解析和标识API数据的请求

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids-result-doc/id-dto'

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

└─id

string

id标识信息

-

└─regOrgCode

string

注册机构码

-

└─fullId

string

传入的完整id信息{type}:{id}。type就是id的标识前缀prefix

-

└─cstrId

string

转换后的cstrId

-

└─type

string

id标识信息,DOI,PMID等

-

└─index

string

对信息的处理,有url(转发),meta是元数据,可以是ids,doi,pmid等

-

└─data

object

标识的具体信息

-

     └─id

string

实际数据库存储的id

-

     └─cstrId

string

cstr标识

-

     └─index

string

存储库

-

     └─type

string

标识类型

-

     └─category

string

标识数据类型,不用去解析cstr里面获取

-

     └─data

object

标识的实际数据,不定数据类型,有各种数据,可以查看各数据快照

-

     └─snapshot

object

快照信息,原来存储在data里面(不好使用,故而新增属性)

-

          └─url

string

获取资源的url

-

          └─htmlTitle

string

资源的网络标题

-

          └─htmlPath

string

资源存储的html相对文件地址信息

-

          └─textPath

string

资源网页的文字信息——去除了html标签信息

-

          └─pdfPath

string

网页上如果有pdf下载,则本地存储的pdf文件

-

          └─pdfLink

string

pdf网络链接

-

          └─snapshotImgPath

string

当前视野的快照的图片

-

          └─fullPageImgPath

string

全网页的快照图片

-

          └─title

string

标题信息

-

          └─tags

array

一些标签信息(主动增加的字段,把其它的一些文本整合在一起——用以搜索之用),从其它字段获取而来

-

          └─absText

string

简介或者介绍,从其它字段获取而来

-

          └─year

int32

No comments found.

-

     └─ttl

int64

有效期

-

     └─timeStamp

int64

存储时间

-

     └─permission

object

权限信息

-

          └─read

string

读权限

-

          └─write

string

写权限

-

          └─createIndex

string

增加index权限

-

          └─deleteIndex

string

删除index权限

-

          └─createCSTR

string

增加标识权限

-

          └─deleteCSTR

string

删除标识权限

-

└─category

string

cstr的类型信息,比如15,16等

-

└─url

array

最终的url

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {
    "id": "",
    "regOrgCode": "",
    "fullId": "",
    "cstrId": "",
    "type": "",
    "index": "",
    "data": {
      "id": "",
      "cstrId": "",
      "index": "",
      "type": "",
      "category": "",
      "data": {},
      "snapshot": {
        "url": "",
        "htmlTitle": "",
        "htmlPath": "",
        "textPath": "",
        "pdfPath": "",
        "pdfLink": "",
        "snapshotImgPath": "",
        "fullPageImgPath": "",
        "title": "",
        "tags": [
          ""
        ],
        "absText": "",
        "year": 0
      },
      "ttl": 0,
      "timeStamp": 0,
      "permission": {
        "read": "",
        "write": "",
        "createIndex": "",
        "deleteIndex": "",
        "createCSTR": "",
        "deleteCSTR": ""
      }
    },
    "category": "",
    "url": [
      ""
    ]
  }
}

2.2.IndexModel说明

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 请求缓存的数据或者已经解析网页和获取标识API的信息

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids-result-doc/index-model'

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

└─id

string

实际数据库存储的id

-

└─cstrId

string

cstr标识

-

└─index

string

存储库

-

└─type

string

标识类型

-

└─category

string

标识数据类型,不用去解析cstr里面获取

-

└─data

object

标识的实际数据,不定数据类型,有各种数据,可以查看各数据快照

-

└─snapshot

object

快照信息,原来存储在data里面(不好使用,故而新增属性)

-

     └─url

string

获取资源的url

-

     └─htmlTitle

string

资源的网络标题

-

     └─htmlPath

string

资源存储的html相对文件地址信息

-

     └─textPath

string

资源网页的文字信息——去除了html标签信息

-

     └─pdfPath

string

网页上如果有pdf下载,则本地存储的pdf文件

-

     └─pdfLink

string

pdf网络链接

-

     └─snapshotImgPath

string

当前视野的快照的图片

-

     └─fullPageImgPath

string

全网页的快照图片

-

     └─title

string

标题信息

-

     └─tags

array

一些标签信息(主动增加的字段,把其它的一些文本整合在一起——用以搜索之用),从其它字段获取而来

-

     └─absText

string

简介或者介绍,从其它字段获取而来

-

     └─year

int32

No comments found.

-

└─ttl

int64

有效期

-

└─timeStamp

int64

存储时间

-

└─permission

object

权限信息

-

     └─read

string

读权限

-

     └─write

string

写权限

-

     └─createIndex

string

增加index权限

-

     └─deleteIndex

string

删除index权限

-

     └─createCSTR

string

增加标识权限

-

     └─deleteCSTR

string

删除标识权限

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {
    "id": "",
    "cstrId": "",
    "index": "",
    "type": "",
    "category": "",
    "data": {},
    "snapshot": {
      "url": "",
      "htmlTitle": "",
      "htmlPath": "",
      "textPath": "",
      "pdfPath": "",
      "pdfLink": "",
      "snapshotImgPath": "",
      "fullPageImgPath": "",
      "title": "",
      "tags": [
        ""
      ],
      "absText": "",
      "year": 0
    },
    "ttl": 0,
    "timeStamp": 0,
    "permission": {
      "read": "",
      "write": "",
      "createIndex": "",
      "deleteIndex": "",
      "createCSTR": "",
      "deleteCSTR": ""
    }
  }
}

2.3.IdsSnapshot 说明

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 标识数据快照——通用数据内容

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids-result-doc/ids-snapshot'

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

└─url

string

获取资源的url

-

└─htmlTitle

string

资源的网络标题

-

└─htmlPath

string

资源存储的html相对文件地址信息

-

└─textPath

string

资源网页的文字信息——去除了html标签信息

-

└─pdfPath

string

网页上如果有pdf下载,则本地存储的pdf文件

-

└─pdfLink

string

pdf网络链接

-

└─snapshotImgPath

string

当前视野的快照的图片

-

└─fullPageImgPath

string

全网页的快照图片

-

└─title

string

标题信息

-

└─tags

array

一些标签信息(主动增加的字段,把其它的一些文本整合在一起——用以搜索之用),从其它字段获取而来

-

└─absText

string

简介或者介绍,从其它字段获取而来

-

└─year

int32

No comments found.

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {
    "url": "",
    "htmlTitle": "",
    "htmlPath": "",
    "textPath": "",
    "pdfPath": "",
    "pdfLink": "",
    "snapshotImgPath": "",
    "fullPageImgPath": "",
    "title": "",
    "tags": [
      ""
    ],
    "absText": "",
    "year": 0
  }
}

2.4.PmidSnapshot 说明

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 标识数据快照——Pmid

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids-result-doc/ids-snapshot-pmid'

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

└─url

string

获取资源的url

-

└─htmlTitle

string

资源的网络标题

-

└─htmlPath

string

资源存储的html相对文件地址信息

-

└─textPath

string

资源网页的文字信息——去除了html标签信息

-

└─pdfPath

string

网页上如果有pdf下载,则本地存储的pdf文件

-

└─pdfLink

string

pdf网络链接

-

└─snapshotImgPath

string

当前视野的快照的图片

-

└─fullPageImgPath

string

全网页的快照图片

-

└─title

string

标题信息

-

└─tags

array

一些标签信息(主动增加的字段,把其它的一些文本整合在一起——用以搜索之用),从其它字段获取而来

-

└─absText

string

简介或者介绍,从其它字段获取而来

-

└─year

int32

No comments found.

-

└─ebiApiData

object

ebi的API获取的信息

-

└─ncbiApiData

object

ncbi的api获取的信息

-

└─ncbiApiXmlData

string

ncbi获取的xml字符串信息

-

└─ncbiApiXmlJsonData

object

根据ncbi获取的xml字符串信息转换成的json数据

-

└─pmid

string

标识id信息

-

└─pubJournal

string

期刊

-

└─citeInfo

string

包含日期信息与一串字符串

-

└─pubDate

string

公开日期

-

└─doi

string

doi信息

-

└─authors

array

作者列表与作者链接信息

-

     └─name

string

作者人名

-

     └─org

array

作者机构信息,机构可能是多个

-

     └─orgIndex

array

作者机构信息的下标,下标可能是多个。更具体的每个下标的信息可以看Affiliations

-

     └─link

string

作者链接

-

└─affiliations

array

affiliations 机构信息

-

     └─name

string

名称

-

     └─index

string

在页面上的展示的下标信息

-

└─interestStatement

string

相关利益冲突声明

-

└─references

array

引用信息

-

└─relatedInfo

array

其它关联信息

-

     └─name

string

相关名称

-

     └─link

string

相关链接

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {
    "url": "",
    "htmlTitle": "",
    "htmlPath": "",
    "textPath": "",
    "pdfPath": "",
    "pdfLink": "",
    "snapshotImgPath": "",
    "fullPageImgPath": "",
    "title": "",
    "tags": [
      ""
    ],
    "absText": "",
    "year": 0,
    "ebiApiData": {},
    "ncbiApiData": {},
    "ncbiApiXmlData": "",
    "ncbiApiXmlJsonData": {},
    "pmid": "",
    "pubJournal": "",
    "citeInfo": "",
    "pubDate": "",
    "doi": "",
    "authors": [
      {
        "name": "",
        "org": [
          ""
        ],
        "orgIndex": [
          ""
        ],
        "link": ""
      }
    ],
    "affiliations": [
      {
        "name": "",
        "index": ""
      }
    ],
    "interestStatement": "",
    "references": [
      ""
    ],
    "relatedInfo": [
      {
        "name": "",
        "link": ""
      }
    ]
  }
}

2.5.DoiSnapshot 说明

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 标识数据快照——doi

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids-result-doc/ids-snapshot-doi'

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

└─url

string

获取资源的url

-

└─htmlTitle

string

资源的网络标题

-

└─htmlPath

string

资源存储的html相对文件地址信息

-

└─textPath

string

资源网页的文字信息——去除了html标签信息

-

└─pdfPath

string

网页上如果有pdf下载,则本地存储的pdf文件

-

└─pdfLink

string

pdf网络链接

-

└─snapshotImgPath

string

当前视野的快照的图片

-

└─fullPageImgPath

string

全网页的快照图片

-

└─title

string

标题信息

-

└─tags

array

一些标签信息(主动增加的字段,把其它的一些文本整合在一起——用以搜索之用),从其它字段获取而来

-

└─absText

string

简介或者介绍,从其它字段获取而来

-

└─year

int32

No comments found.

-

└─sourceUrl

string

源url

-

└─doiApiData

object

doi的官方api获取的信息——一般是会有一条文献原始地址的url,其它信息无

-

└─crossrefApiData

object

crossref的API获取的信息

-

└─opencitationsApiData

object

opencitations的API获取的信息

-

└─dataciteApiData

object

datacite的API获取的信息

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {
    "url": "",
    "htmlTitle": "",
    "htmlPath": "",
    "textPath": "",
    "pdfPath": "",
    "pdfLink": "",
    "snapshotImgPath": "",
    "fullPageImgPath": "",
    "title": "",
    "tags": [
      ""
    ],
    "absText": "",
    "year": 0,
    "sourceUrl": "",
    "doiApiData": {},
    "crossrefApiData": {},
    "opencitationsApiData": {},
    "dataciteApiData": {}
  }
}

2.6.CstridSnapshot 说明

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 标识数据快照——cstr

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids-result-doc/ids-snapshot-cstr'

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

└─url

string

获取资源的url

-

└─htmlTitle

string

资源的网络标题

-

└─htmlPath

string

资源存储的html相对文件地址信息

-

└─textPath

string

资源网页的文字信息——去除了html标签信息

-

└─pdfPath

string

网页上如果有pdf下载,则本地存储的pdf文件

-

└─pdfLink

string

pdf网络链接

-

└─snapshotImgPath

string

当前视野的快照的图片

-

└─fullPageImgPath

string

全网页的快照图片

-

└─title

string

标题信息

-

└─tags

array

一些标签信息(主动增加的字段,把其它的一些文本整合在一起——用以搜索之用),从其它字段获取而来

-

└─absText

string

简介或者介绍,从其它字段获取而来

-

└─year

int32

No comments found.

-

└─cstrId

string

CSTR完整号,CSTR:15398.11.A00120001

-

└─orgId

string

所属机构id:774e75b21ac511e980780242ac120006

-

└─orgName

string

机构名称:国家气象科学数据中心

-

└─orgType

int32

机构类型:6是数据中心,其它类型见共享网

-

└─keywords

string

相关关键词,分号分割:气压;风向;风速;温度;相对湿度;降水量

-

└─descr

string

概述介绍信息

-

└─subject

string

学科分类:地球科学

-

└─theme

string

主题分类

-

└─owner

string

拥有者:国家气象科学数据中心

-

└─serviceOrg

string

服务单位

-

└─serviceOrgAddr

string

服务单位详细地址

-

└─serviceOrgPostCode

string

服务单位邮编

-

└─serviceOrgPhone

string

服务单位号

-

└─serviceOrgEmail

string

服务单位邮箱

-

└─sharePathway

string

共享方式:线上共享

-

└─shareScope

string

共享范围:有条件共享

-

└─applicationProcess

string

申请方式:网站实名注册下载

-

└─link

string

详细链接:http://data.cma.cn/data/cdcdetail/dataCode/A.0012.0001.html

-

└─utime

string

更新时间

-

└─ctime

string

创建时间

-

└─extendFields

array

扩展字段

-

└─generateDate

string

生成日期:2023-02-15

-

└─keywordsArr

array

关键词

-

└─subjectArr

array

学科分类

-

└─themeArr

array

主题分类

-

└─submitOrganizationName

string

提交机构名称

-

└─submitOrganizationAddress

string

提交机构地址

-

└─submitOrganizationPostalCode

string

提交机构邮编

-

└─submitOrganizationPhoneNumber

string

提交机构电话

-

└─submitOrganizationMail

string

提交机构邮箱

-

└─categoryCode

string

分类号

-

└─categoryName

string

分类号名称

-

└─categoryStandardName

string

分类标准名称

-

└─categoryStandardVersion

string

分类标准版本

-

└─referenceSuggestion

string

引用方式建议

-

└─registerOrgName

string

注册机构名称

-

└─registerOrgAddress

string

注册机构地址

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {
    "url": "",
    "htmlTitle": "",
    "htmlPath": "",
    "textPath": "",
    "pdfPath": "",
    "pdfLink": "",
    "snapshotImgPath": "",
    "fullPageImgPath": "",
    "title": "",
    "tags": [
      ""
    ],
    "absText": "",
    "year": 0,
    "cstrId": "",
    "orgId": "",
    "orgName": "",
    "orgType": 0,
    "keywords": "",
    "descr": "",
    "subject": "",
    "theme": "",
    "owner": "",
    "serviceOrg": "",
    "serviceOrgAddr": "",
    "serviceOrgPostCode": "",
    "serviceOrgPhone": "",
    "serviceOrgEmail": "",
    "sharePathway": "",
    "shareScope": "",
    "applicationProcess": "",
    "link": "",
    "utime": "",
    "ctime": "",
    "extendFields": [
      ""
    ],
    "generateDate": "",
    "keywordsArr": [
      ""
    ],
    "subjectArr": [
      ""
    ],
    "themeArr": [
      ""
    ],
    "submitOrganizationName": "",
    "submitOrganizationAddress": "",
    "submitOrganizationPostalCode": "",
    "submitOrganizationPhoneNumber": "",
    "submitOrganizationMail": "",
    "categoryCode": "",
    "categoryName": "",
    "categoryStandardName": "",
    "categoryStandardVersion": "",
    "referenceSuggestion": "",
    "registerOrgName": "",
    "registerOrgAddress": ""
  }
}

2.7.OrcidSnapshot 说明

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 标识数据快照——orcid

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids-result-doc/ids-snapshot-orcid'

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

└─url

string

获取资源的url

-

└─htmlTitle

string

资源的网络标题

-

└─htmlPath

string

资源存储的html相对文件地址信息

-

└─textPath

string

资源网页的文字信息——去除了html标签信息

-

└─pdfPath

string

网页上如果有pdf下载,则本地存储的pdf文件

-

└─pdfLink

string

pdf网络链接

-

└─snapshotImgPath

string

当前视野的快照的图片

-

└─fullPageImgPath

string

全网页的快照图片

-

└─title

string

标题信息

-

└─tags

array

一些标签信息(主动增加的字段,把其它的一些文本整合在一起——用以搜索之用),从其它字段获取而来

-

└─absText

string

简介或者介绍,从其它字段获取而来

-

└─year

int32

No comments found.

-

└─id

string

id

-

└─idUrl

string

id相关的url

-

└─country

string

国家信息

-

└─keywords

string

关键词信息

-

└─publicRecords

object

根据https://orcid.org/{id}/public-record.json 获取的信息

-

└─userInfo

object

根据https://orcid.org/{id}/userInfo.json 获取的信息

-

     └─EFFECTIVE_USER_ORCID

string

No comments found.

-

     └─IS_DEACTIVATED

string

No comments found.

-

     └─IS_LOCKED

string

No comments found.

-

     └─READY_FOR_INDEXING

string

No comments found.

-

└─summary

object

根据https://orcid.org/{id}/summary.json 获取的信息

-

└─apiData

object

根据API https://pub.orcid.org/v3.0/{id}/person 获取的信息

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {
    "url": "",
    "htmlTitle": "",
    "htmlPath": "",
    "textPath": "",
    "pdfPath": "",
    "pdfLink": "",
    "snapshotImgPath": "",
    "fullPageImgPath": "",
    "title": "",
    "tags": [
      ""
    ],
    "absText": "",
    "year": 0,
    "id": "",
    "idUrl": "",
    "country": "",
    "keywords": "",
    "publicRecords": {},
    "userInfo": {
      "EFFECTIVE_USER_ORCID": "",
      "IS_DEACTIVATED": "",
      "IS_LOCKED": "",
      "READY_FOR_INDEXING": ""
    },
    "summary": {},
    "apiData": {}
  }
}

2.8.IsniSnapshot 说明

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 标识数据快照——isni

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids-result-doc/ids-snapshot-isni'

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

└─url

string

获取资源的url

-

└─htmlTitle

string

资源的网络标题

-

└─htmlPath

string

资源存储的html相对文件地址信息

-

└─textPath

string

资源网页的文字信息——去除了html标签信息

-

└─pdfPath

string

网页上如果有pdf下载,则本地存储的pdf文件

-

└─pdfLink

string

pdf网络链接

-

└─snapshotImgPath

string

当前视野的快照的图片

-

└─fullPageImgPath

string

全网页的快照图片

-

└─title

string

标题信息

-

└─tags

array

一些标签信息(主动增加的字段,把其它的一些文本整合在一起——用以搜索之用),从其它字段获取而来

-

└─absText

string

简介或者介绍,从其它字段获取而来

-

└─year

int32

No comments found.

-

└─searchTerm

string

搜索框内容

-

└─isniNum

string

ISNI号

-

└─isniLink

string

isni名称

-

└─rdfLink

string

rdf信息网页链接

-

└─rdfFilePath

string

rdf本地存储文件相对路径

-

└─jsonLink

string

json信息网页链接

-

└─jsonFilePath

string

json本地存储文件相对路径

-

└─names

array

名称

-

└─dates

array

日期信息

-

└─creationClass

array

Creation Class

-

└─creationRole

array

creation role

-

└─relatedNames

array

related names

-

└─titles

array

titles

-

└─notes

array

notes

-

└─sources

array

sources

-

     └─name

string

source name

-

     └─link

string

source link

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {
    "url": "",
    "htmlTitle": "",
    "htmlPath": "",
    "textPath": "",
    "pdfPath": "",
    "pdfLink": "",
    "snapshotImgPath": "",
    "fullPageImgPath": "",
    "title": "",
    "tags": [
      ""
    ],
    "absText": "",
    "year": 0,
    "searchTerm": "",
    "isniNum": "",
    "isniLink": "",
    "rdfLink": "",
    "rdfFilePath": "",
    "jsonLink": "",
    "jsonFilePath": "",
    "names": [
      ""
    ],
    "dates": [
      ""
    ],
    "creationClass": [
      ""
    ],
    "creationRole": [
      ""
    ],
    "relatedNames": [
      ""
    ],
    "titles": [
      ""
    ],
    "notes": [
      ""
    ],
    "sources": [
      {
        "name": "",
        "link": ""
      }
    ]
  }
}

2.9.IsliSnapshot 说明

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 标识数据快照——isli

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids-result-doc/ids-snapshot-isli'

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

└─url

string

获取资源的url

-

└─htmlTitle

string

资源的网络标题

-

└─htmlPath

string

资源存储的html相对文件地址信息

-

└─textPath

string

资源网页的文字信息——去除了html标签信息

-

└─pdfPath

string

网页上如果有pdf下载,则本地存储的pdf文件

-

└─pdfLink

string

pdf网络链接

-

└─snapshotImgPath

string

当前视野的快照的图片

-

└─fullPageImgPath

string

全网页的快照图片

-

└─title

string

标题信息

-

└─tags

array

一些标签信息(主动增加的字段,把其它的一些文本整合在一起——用以搜索之用),从其它字段获取而来

-

└─absText

string

简介或者介绍,从其它字段获取而来

-

└─year

int32

No comments found.

-

└─data

object

API获取的数据信息

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {
    "url": "",
    "htmlTitle": "",
    "htmlPath": "",
    "textPath": "",
    "pdfPath": "",
    "pdfLink": "",
    "snapshotImgPath": "",
    "fullPageImgPath": "",
    "title": "",
    "tags": [
      ""
    ],
    "absText": "",
    "year": 0,
    "data": {}
  }
}

2.10.IsbnidSnapshot 说明

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 标识数据快照——isbn

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids-result-doc/ids-snapshot-isbn'

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

└─url

string

获取资源的url

-

└─htmlTitle

string

资源的网络标题

-

└─htmlPath

string

资源存储的html相对文件地址信息

-

└─textPath

string

资源网页的文字信息——去除了html标签信息

-

└─pdfPath

string

网页上如果有pdf下载,则本地存储的pdf文件

-

└─pdfLink

string

pdf网络链接

-

└─snapshotImgPath

string

当前视野的快照的图片

-

└─fullPageImgPath

string

全网页的快照图片

-

└─title

string

标题信息

-

└─tags

array

一些标签信息(主动增加的字段,把其它的一些文本整合在一起——用以搜索之用),从其它字段获取而来

-

└─absText

string

简介或者介绍,从其它字段获取而来

-

└─year

int32

No comments found.

-

└─bookImg

string

书籍的图片网页地址

-

└─bookLocalImgPath

string

图片本地相对路径地址

-

└─isbn13

string

isbn13

-

└─isbn13Link

string

相关isbn13链接

-

└─isbn10

string

isbn10

-

└─isbn10Link

string

相关isbn10链接

-

└─authors

string

作者信息

-

└─edition

string

版本信息

-

└─binding

string

binding

-

└─publisher

string

出版商

-

└─published

string

出版日期

-

└─openlibraryApiData

object

根据openlibrary的API获取的信息——需要能访问外网

-

└─googleApiData

object

根据google的API获取的信息——需要能访问外网

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {
    "url": "",
    "htmlTitle": "",
    "htmlPath": "",
    "textPath": "",
    "pdfPath": "",
    "pdfLink": "",
    "snapshotImgPath": "",
    "fullPageImgPath": "",
    "title": "",
    "tags": [
      ""
    ],
    "absText": "",
    "year": 0,
    "bookImg": "",
    "bookLocalImgPath": "",
    "isbn13": "",
    "isbn13Link": "",
    "isbn10": "",
    "isbn10Link": "",
    "authors": "",
    "edition": "",
    "binding": "",
    "publisher": "",
    "published": "",
    "openlibraryApiData": {},
    "googleApiData": {}
  }
}

3.跨域标识自动注册信息查询入口

3.1.分页查询跨域标识

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 分页查询跨域标识

Query-parameters:

ParameterTypeDescriptionRequiredSince

idType

string

查询的标识类型

false

-

category

string

标识的数据类型

false

-

id

string

查询的标识cstrid信息

false

-

page

int32

No comments found.

false

-

size

int32

No comments found.

false

-

sort

string

No comments found.

false

-

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids-manage/data/page?page=0&size=0&idType=&category=&id=&sort='

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

└─number

int32

Returns the number of the current {@link Slice}. Is always non-negative.

-

└─size

int32

Returns the size of the {@link Slice}.

-

└─numberOfElements

int32

Returns the number of elements currently on this {@link Slice}.

-

└─sort

object

Returns the sorting parameters for the {@link Slice}.

-

     └─empty

boolean

Returns whether the current {@link Streamable} is empty.

-

     └─orders

array

No comments found.

-

          └─direction

enum

No comments found.
(See: Enumeration for sort directions.)

-

          └─property

string

No comments found.

-

          └─ignoreCase

boolean

No comments found.

-

          └─nullHandling

enum

No comments found.
(See: Enumeration for null handling hints that can be used in {@link Order} expressions.)

-

└─first

boolean

Returns whether the current {@link Slice} is the first one.

-

└─last

boolean

Returns whether the current {@link Slice} is the last one.

-

└─empty

boolean

Returns whether the current {@link Streamable} is empty.

-

└─content

array

No comments found.

-

     └─id

string

实际数据库存储的id

-

     └─cstrId

string

cstr标识

-

     └─index

string

存储库

-

     └─type

string

标识类型

-

     └─category

string

标识数据类型,不用去解析cstr里面获取

-

     └─data

object

标识的实际数据,不定数据类型,有各种数据,可以查看各数据快照

-

     └─snapshot

object

快照信息,原来存储在data里面(不好使用,故而新增属性)

-

          └─url

string

获取资源的url

-

          └─htmlTitle

string

资源的网络标题

-

          └─htmlPath

string

资源存储的html相对文件地址信息

-

          └─textPath

string

资源网页的文字信息——去除了html标签信息

-

          └─pdfPath

string

网页上如果有pdf下载,则本地存储的pdf文件

-

          └─pdfLink

string

pdf网络链接

-

          └─snapshotImgPath

string

当前视野的快照的图片

-

          └─fullPageImgPath

string

全网页的快照图片

-

          └─title

string

标题信息

-

          └─tags

array

一些标签信息(主动增加的字段,把其它的一些文本整合在一起——用以搜索之用),从其它字段获取而来

-

          └─absText

string

简介或者介绍,从其它字段获取而来

-

          └─year

int32

No comments found.

-

     └─ttl

int64

有效期

-

     └─timeStamp

int64

存储时间

-

     └─permission

object

权限信息

-

          └─read

string

读权限

-

          └─write

string

写权限

-

          └─createIndex

string

增加index权限

-

          └─deleteIndex

string

删除index权限

-

          └─createCSTR

string

增加标识权限

-

          └─deleteCSTR

string

删除标识权限

-

└─pageable

object

No comments found.

-

     └─paged

boolean

Returns whether the current {@link Pageable} contains pagination information.

-

     └─unpaged

boolean

Returns whether the current {@link Pageable} does not contain pagination information.

-

     └─pageNumber

int32

Returns the page to be returned.

-

     └─pageSize

int32

Returns the number of items to be returned.

-

     └─offset

int64

Returns the offset to be taken according to the underlying page and page size.

-

     └─sort

object

Returns the sorting parameters.

-

          └─empty

boolean

Returns whether the current {@link Streamable} is empty.

-

          └─orders

array

No comments found.

-

               └─direction

enum

No comments found.
(See: Enumeration for sort directions.)

-

               └─property

string

No comments found.

-

               └─ignoreCase

boolean

No comments found.

-

               └─nullHandling

enum

No comments found.
(See: Enumeration for null handling hints that can be used in {@link Order} expressions.)

-

└─totalPages

int32

Returns the number of total pages.

-

└─totalElements

int64

Returns the total amount of elements.

-

└─total

int64

No comments found.

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {
    "number": 0,
    "size": 0,
    "numberOfElements": 0,
    "sort": {
      "empty": true,
      "orders": [
        {
          "direction": "ASC",
          "property": "",
          "ignoreCase": true,
          "nullHandling": "NATIVE"
        }
      ]
    },
    "first": true,
    "last": true,
    "empty": true,
    "content": [
      {
        "id": "",
        "cstrId": "",
        "index": "",
        "type": "",
        "category": "",
        "data": {},
        "snapshot": {
          "url": "",
          "htmlTitle": "",
          "htmlPath": "",
          "textPath": "",
          "pdfPath": "",
          "pdfLink": "",
          "snapshotImgPath": "",
          "fullPageImgPath": "",
          "title": "",
          "tags": [
            ""
          ],
          "absText": "",
          "year": 0
        },
        "ttl": 0,
        "timeStamp": 0,
        "permission": {
          "read": "",
          "write": "",
          "createIndex": "",
          "deleteIndex": "",
          "createCSTR": "",
          "deleteCSTR": ""
        }
      }
    ],
    "pageable": {
      "paged": true,
      "unpaged": true,
      "pageNumber": 0,
      "pageSize": 0,
      "offset": 0,
      "sort": {
        "empty": true,
        "orders": [
          {
            "direction": "ASC",
            "property": "",
            "ignoreCase": true,
            "nullHandling": "NATIVE"
          }
        ]
      }
    },
    "totalPages": 0,
    "totalElements": 0,
    "total": 0
  }
}

4.跨域标识解析日志信息查询入口

4.1.分页查询解析日志

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 分页查询解析日志

Query-parameters:

ParameterTypeDescriptionRequiredSince

type

string

标识类型,doi,pmid等

false

-

category

string

标识数据类型

false

-

id

string

id

false

-

page

int32

No comments found.

false

-

size

int32

No comments found.

false

-

sort

string

No comments found.

false

-

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids-manage/parse-log/page?page=0&size=0&type=&category=&id=&sort='

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

└─totalPages

int32

Returns the number of total pages.

-

└─totalElements

int64

Returns the total amount of elements.

-

└─number

int32

Returns the number of the current {@link Slice}. Is always non-negative.

-

└─size

int32

Returns the size of the {@link Slice}.

-

└─numberOfElements

int32

Returns the number of elements currently on this {@link Slice}.

-

└─content

array

Returns the page content as {@link List}.

-

     └─id

int64

No comments found.

-

     └─dto

object

No comments found.

-

          └─id

string

id标识信息

-

          └─regOrgCode

string

注册机构码

-

          └─fullId

string

传入的完整id信息{type}:{id}。type就是id的标识前缀prefix

-

          └─cstrId

string

转换后的cstrId

-

          └─type

string

id标识信息,DOI,PMID等

-

          └─index

string

对信息的处理,有url(转发),meta是元数据,可以是ids,doi,pmid等

-

          └─data

object

标识的具体信息

-

               └─id

string

实际数据库存储的id

-

               └─cstrId

string

cstr标识

-

               └─index

string

存储库

-

               └─type

string

标识类型

-

               └─category

string

标识数据类型,不用去解析cstr里面获取

-

               └─data

object

标识的实际数据,不定数据类型,有各种数据,可以查看各数据快照

-

               └─snapshot

object

快照信息,原来存储在data里面(不好使用,故而新增属性)

-

                    └─url

string

获取资源的url

-

                    └─htmlTitle

string

资源的网络标题

-

                    └─htmlPath

string

资源存储的html相对文件地址信息

-

                    └─textPath

string

资源网页的文字信息——去除了html标签信息

-

                    └─pdfPath

string

网页上如果有pdf下载,则本地存储的pdf文件

-

                    └─pdfLink

string

pdf网络链接

-

                    └─snapshotImgPath

string

当前视野的快照的图片

-

                    └─fullPageImgPath

string

全网页的快照图片

-

                    └─title

string

标题信息

-

                    └─tags

array

一些标签信息(主动增加的字段,把其它的一些文本整合在一起——用以搜索之用),从其它字段获取而来

-

                    └─absText

string

简介或者介绍,从其它字段获取而来

-

                    └─year

int32

No comments found.

-

               └─ttl

int64

有效期

-

               └─timeStamp

int64

存储时间

-

               └─permission

object

权限信息

-

                    └─read

string

读权限

-

                    └─write

string

写权限

-

                    └─createIndex

string

增加index权限

-

                    └─deleteIndex

string

删除index权限

-

                    └─createCSTR

string

增加标识权限

-

                    └─deleteCSTR

string

删除标识权限

-

          └─category

string

cstr的类型信息,比如15,16等

-

          └─url

array

最终的url

-

     └─ctime

int64

No comments found.

-

     └─cost

int64

No comments found.

-

     └─username

string

No comments found.

-

     └─useragent

string

ua信息

-

     └─brand

string

No comments found.

-

     └─os

string

No comments found.

-

     └─browser

string

No comments found.

-

     └─ip

string

ip信息

-

     └─country

string

No comments found.

-

     └─province

string

No comments found.

-

     └─city

string

No comments found.

-

     └─lat

double

No comments found.

-

     └─lng

double

No comments found.

-

└─sort

object

Returns the sorting parameters for the {@link Slice}.

-

     └─empty

boolean

Returns whether the current {@link Streamable} is empty.

-

     └─orders

array

No comments found.

-

          └─direction

enum

No comments found.
(See: Enumeration for sort directions.)

-

          └─property

string

No comments found.

-

          └─ignoreCase

boolean

No comments found.

-

          └─nullHandling

enum

No comments found.
(See: Enumeration for null handling hints that can be used in {@link Order} expressions.)

-

└─first

boolean

Returns whether the current {@link Slice} is the first one.

-

└─last

boolean

Returns whether the current {@link Slice} is the last one.

-

└─pageable

object

Returns the {@link Pageable} that's been used to request the current {@link Slice}.

2.0

     └─paged

boolean

Returns whether the current {@link Pageable} contains pagination information.

-

     └─unpaged

boolean

Returns whether the current {@link Pageable} does not contain pagination information.

-

     └─pageNumber

int32

Returns the page to be returned.

-

     └─pageSize

int32

Returns the number of items to be returned.

-

     └─offset

int64

Returns the offset to be taken according to the underlying page and page size.

-

     └─sort

object

Returns the sorting parameters.

-

          └─empty

boolean

Returns whether the current {@link Streamable} is empty.

-

          └─orders

array

No comments found.

-

               └─direction

enum

No comments found.
(See: Enumeration for sort directions.)

-

               └─property

string

No comments found.

-

               └─ignoreCase

boolean

No comments found.

-

               └─nullHandling

enum

No comments found.
(See: Enumeration for null handling hints that can be used in {@link Order} expressions.)

-

└─empty

boolean

Returns whether the current {@link Streamable} is empty.

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {
    "totalPages": 0,
    "totalElements": 0,
    "number": 0,
    "size": 0,
    "numberOfElements": 0,
    "content": [
      {
        "id": 0,
        "dto": {
          "id": "",
          "regOrgCode": "",
          "fullId": "",
          "cstrId": "",
          "type": "",
          "index": "",
          "data": {
            "id": "",
            "cstrId": "",
            "index": "",
            "type": "",
            "category": "",
            "data": {},
            "snapshot": {
              "url": "",
              "htmlTitle": "",
              "htmlPath": "",
              "textPath": "",
              "pdfPath": "",
              "pdfLink": "",
              "snapshotImgPath": "",
              "fullPageImgPath": "",
              "title": "",
              "tags": [
                ""
              ],
              "absText": "",
              "year": 0
            },
            "ttl": 0,
            "timeStamp": 0,
            "permission": {
              "read": "",
              "write": "",
              "createIndex": "",
              "deleteIndex": "",
              "createCSTR": "",
              "deleteCSTR": ""
            }
          },
          "category": "",
          "url": [
            ""
          ]
        },
        "ctime": 0,
        "cost": 0,
        "username": "",
        "useragent": "",
        "brand": "",
        "os": "",
        "browser": "",
        "ip": "",
        "country": "",
        "province": "",
        "city": "",
        "lat": 0.0,
        "lng": 0.0
      }
    ],
    "sort": {
      "empty": true,
      "orders": [
        {
          "direction": "ASC",
          "property": "",
          "ignoreCase": true,
          "nullHandling": "NATIVE"
        }
      ]
    },
    "first": true,
    "last": true,
    "pageable": {
      "paged": true,
      "unpaged": true,
      "pageNumber": 0,
      "pageSize": 0,
      "offset": 0,
      "sort": {
        "empty": true,
        "orders": [
          {
            "direction": "ASC",
            "property": "",
            "ignoreCase": true,
            "nullHandling": "NATIVE"
          }
        ]
      }
    },
    "empty": true
  }
}

5.跨域标识心跳检测日志信息

5.1.分页查询解析日志

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 分页查询解析日志

Query-parameters:

ParameterTypeDescriptionRequiredSince

idType

string

标识类型,doi,pmid等

false

-

host

string

域名host

false

-

status

string

状态:DOWN或者UP

false

-

code

int32

返回码

false

-

page

int32

No comments found.

false

-

size

int32

No comments found.

false

-

sort

string

No comments found.

false

-

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids-manage/heartbeat/page?code=0&page=0&size=0&idType=&host=&status=&sort=' --data '&0'

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

└─totalPages

int32

Returns the number of total pages.

-

└─totalElements

int64

Returns the total amount of elements.

-

└─number

int32

Returns the number of the current {@link Slice}. Is always non-negative.

-

└─size

int32

Returns the size of the {@link Slice}.

-

└─numberOfElements

int32

Returns the number of elements currently on this {@link Slice}.

-

└─content

array

Returns the page content as {@link List}.

-

     └─url

string

访问的url,host

-

     └─host

string

No comments found.

-

     └─idType

string

标识类型

-

     └─status

string

自定义的额两种状态,up down cn.org.escience.cstr.service.ids.constants.HostStatus

-

     └─code

int32

请求返回消息码

-

     └─msg

string

如果异常,记录下异常消息

-

     └─ctime

int64

消息往数据库开始插入的时间

-

     └─cost

int64

请求耗时

-

     └─requestTime

int64

请求时间

-

└─sort

object

Returns the sorting parameters for the {@link Slice}.

-

     └─empty

boolean

Returns whether the current {@link Streamable} is empty.

-

     └─orders

array

No comments found.

-

          └─direction

enum

No comments found.
(See: Enumeration for sort directions.)

-

          └─property

string

No comments found.

-

          └─ignoreCase

boolean

No comments found.

-

          └─nullHandling

enum

No comments found.
(See: Enumeration for null handling hints that can be used in {@link Order} expressions.)

-

└─first

boolean

Returns whether the current {@link Slice} is the first one.

-

└─last

boolean

Returns whether the current {@link Slice} is the last one.

-

└─pageable

object

Returns the {@link Pageable} that's been used to request the current {@link Slice}.

2.0

     └─paged

boolean

Returns whether the current {@link Pageable} contains pagination information.

-

     └─unpaged

boolean

Returns whether the current {@link Pageable} does not contain pagination information.

-

     └─pageNumber

int32

Returns the page to be returned.

-

     └─pageSize

int32

Returns the number of items to be returned.

-

     └─offset

int64

Returns the offset to be taken according to the underlying page and page size.

-

     └─sort

object

Returns the sorting parameters.

-

          └─empty

boolean

Returns whether the current {@link Streamable} is empty.

-

          └─orders

array

No comments found.

-

               └─direction

enum

No comments found.
(See: Enumeration for sort directions.)

-

               └─property

string

No comments found.

-

               └─ignoreCase

boolean

No comments found.

-

               └─nullHandling

enum

No comments found.
(See: Enumeration for null handling hints that can be used in {@link Order} expressions.)

-

└─empty

boolean

Returns whether the current {@link Streamable} is empty.

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {
    "totalPages": 0,
    "totalElements": 0,
    "number": 0,
    "size": 0,
    "numberOfElements": 0,
    "content": [
      {
        "url": "",
        "host": "",
        "idType": "",
        "status": "",
        "code": 0,
        "msg": "",
        "ctime": 0,
        "cost": 0,
        "requestTime": 0
      }
    ],
    "sort": {
      "empty": true,
      "orders": [
        {
          "direction": "ASC",
          "property": "",
          "ignoreCase": true,
          "nullHandling": "NATIVE"
        }
      ]
    },
    "first": true,
    "last": true,
    "pageable": {
      "paged": true,
      "unpaged": true,
      "pageNumber": 0,
      "pageSize": 0,
      "offset": 0,
      "sort": {
        "empty": true,
        "orders": [
          {
            "direction": "ASC",
            "property": "",
            "ignoreCase": true,
            "nullHandling": "NATIVE"
          }
        ]
      }
    },
    "empty": true
  }
}

6.跨域标识搜索

6.1.搜索标识与标识前缀搜索,暂时只检查id是否存在——被注册

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 搜索标识与标识前缀搜索,暂时只检查id是否存在——被注册

Query-parameters:

ParameterTypeDescriptionRequiredSince

index

string

表示搜索的那个库

false

-

q

string

查询的id信息

true

-

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids-search?index=url&q='

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {}
}

6.2.批量解析

Type: POST

Author: zzq

Content-Type: application/json

Description: 批量解析

Body-parameters:

ParameterTypeDescriptionRequiredSince

index

string

表示搜索的那个库

false

-

queryIds

array

查询的id列表信息,[array of string]

false

-

Request-example:

curl -X POST -k -H "Content-Type: application/json" -i 'https://cstr.tech/ids-search/batch?index="url"' --data '[
  ""
]'

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

Response-example:

{
  "msg": "",
  "code": 0,
  "data": {}
}

6.3.跨域标识全文搜索接口

Type: GET

Author: zzq

Content-Type: application/x-www-form-urlencoded

Description: 跨域标识全文搜索接口

Query-parameters:

ParameterTypeDescriptionRequiredSince

type

string

查询的标识类型

false

-

category

string

标识的数据类型

false

-

title

string

标识的标题信息,会查询title和content

false

-

tag

string

标签信息,比如作者等

false

-

current

int32

分页页码信息

false

-

size

int32

分页大小

false

-

Request-example:

curl -X GET -k -i 'https://cstr.tech/ids-search/page?current=1&size=10&type=&category=&title=&tag=' --data '&"1"&"10"'

Response-fields:

FieldTypeDescriptionSince

msg

string

返回消息

-

code

int32

返回状态码

-

data

object

返回消息实体

-

└─number

int32

Returns the number of the current {@link Slice}. Is always non-negative.

-

└─size

int32

Returns the size of the {@link Slice}.

-

└─numberOfElements

int32

Returns the number of elements currently on this {@link Slice}.

-

└─sort

object

Returns the sorting parameters for the {@link Slice}.

-

     └─empty

boolean

Returns whether the current {@link Streamable} is empty.

-

     └─orders

array

No comments found.

-

          └─direction

enum

No comments found.
(See: Enumeration for sort directions.)

-

          └─property

string

No comments found.

-

          └─ignoreCase

boolean

No comments found.

-

          └─nullHandling

enum

No comments found.
(See: Enumeration for null handling hints that can be used in {@link Order} expressions.)

-

└─first

boolean

Returns whether the current {@link Slice} is the first one.

-

└─last

boolean

Returns whether the current {@link Slice} is the last one.

-

└─empty

boolean

Returns whether the current {@link Streamable} is empty.

-

└─content

array

No comments found.

-

     └─type

string

id类型

-

     └─category

string

数据类型

-

     └─title

string

相关标题

-

     └─content

string

相关介绍信息

-

     └─tags

array

其它标签信息,可以是任意的

-

     └─year

int32

No comments found.

-

     └─ctime

int64

No comments found.

-

     └─utime

int64

No comments found.

-

     └─id

string

No comments found.

-

     └─score

double

No comments found.

-

     └─highlight

object

No comments found.

-

          └─ -

array[string]

array of string

-

└─pageable

object

No comments found.

-

     └─paged

boolean

Returns whether the current {@link Pageable} contains pagination information.

-

     └─unpaged

boolean

Returns whether the current {@link Pageable} does not contain pagination information.

-

     └─pageNumber

int32

Returns the page to be returned.

-

     └─pageSize

int32

Returns the number of items to be returned.

-

     └─offset

int64

Returns the offset to be taken according to the underlying page and page size.

-

     └─sort

object

Returns the sorting parameters.

-

          └─empty

boolean

Returns whether the current {@link Streamable} is empty.

-

          └─orders

array

No comments found.

-

               └─direction

enum

No comments found.
(See: Enumeration for sort directions.)

-

               └─property

string

No comments found.

-

               └─ignoreCase

boolean

No comments found.

-

               └─nullHandling

enum

No comments found.
(See: Enumeration for null handling hints that can be used in {@link Order} expressions.)

-

└─totalPages

int32

Returns the number of total pages.

-

└─totalElements

int64

Returns the total amount of elements.

-

└─total

int64

No comments found.

-

Response-example:

{"msg":"","code":0,"data":{"number":0,"size":0,"numberOfElements":0,"sort":{"empty":true,"orders":[{"direction":"ASC","property":"","ignoreCase":true,"nullHandling":"NATIVE"}]},"first":true,"last":true,"empty":true,"content":[{"type":"","category":"","title":"","content":"","tags":[""],"year":0,"ctime":0,"utime":0,"id":"","score":0.0,"highlight":{"mapKey":}}],"pageable":{"paged":true,"unpaged":true,"pageNumber":0,"pageSize":0,"offset":0,"sort":{"empty":true,"orders":[{"direction":"ASC","property":"","ignoreCase":true,"nullHandling":"NATIVE"}]}},"totalPages":0,"totalElements":0,"total":0}}
Top