For Users

The CSTR Identification Platform offers CSTR registration for different metadata templates including science data, journal articles, patents, software copyrights, preprints, instruments, dissertations. If you have any questions please contact(cstr@cnic.cn

SDK source code preview and download at https://gitee.com/datapid/pid-sdk-java.git

Request Address

Environment HTTPS Request Address Method
Official Environment https://www.cstr.cn/openapi/v2/pid-common-service/registerIdentity/batch.register/{type} POST
Sandbox Environment https://www.cstr.cn/sandbox/openapi/v2/pid-common-service/registerIdentity/batch.register/{type} POST

The {type} in the request parameter is the identification metadata template type, with a value range

No. type Description
1 commondata science data
2 journal journal article
3 patent patent
4 sftcopyright software copyright
5 preprint preprint
6 equipment instrument
7 dissertation dissertation

Public Request Parameters

Parameter Type Required Maximum Length Description Example Value
clientId String Yes 32 The application ID assigned to the developer 2014072300007148
secret String Yes 32 Key 32-bit length string

Parameter details

The Body request parameter is identification metadata in the format of xml or JSON. The metadata description is as follows

No. Metadata template type Description urls
1 commondata science data science data
2 journal journal article journal article
3 patent patent patent
4 sftcopyright software copyright software copyright
5 preprint preprint preprint
6 equipment instrument instrument
7 dissertation dissertation dissertation

Public Request Parameters

Parameter Type Required Maximum Length Description Example Value
code int Yes - Gateway return status code 200
message String Yes - Gateway Return Code Description Message Identifies registration failure
timestamp String Yes - Timestamps, see specific API interface documentation 2021-04-06 10:06:35
data Map No - Operational return data, see response parameters String, object

Example of request parameters

No. Metadata template type Description urls
1 commondata science data 《science data-Parameter examples》
2 journal journal article 《journal article-Parameter examples》
3 patent patent 《patent-Parameter examples》
4 sftcopyright software copyright 《software copyright-Parameter examples》
5 preprint preprint 《preprint-Parameter examples》
6 equipment instrument 《instrument-Parameter examples》
7 dissertation dissertation 《dissertation-Parameter examples》

Request Example

Response Example

Exception Example

Status Code

Code Description Solution
200 Registration Success
400 Bad Request Please check the request parameter format
500 Internal Server Error Please verify the failure message against the returned parameters and re-initiate the request