开发文档

了解如何使用我们的API和SDK,快速构建标识解析应用

快速开始

按照以下步骤,快速开始使用工业互联标识解析平台的API和SDK。

1. 注册账号

首先,您需要在我们的平台上注册一个开发者账号。注册完成后,您将获得API密钥,用于API调用的身份验证。

2. 安装SDK

选择您需要的编程语言SDK进行安装:

Java

// 通过Maven安装
<dependency>
    <groupId>com.example</groupId>
    <artifactId>industrial-resolver-sdk</artifactId>
    <version>1.0.0</version>
</dependency>

Python

pip install industrial-resolver-sdk

Node.js

npm install industrial-resolver-sdk

3. 进行首次API调用

以下是一个简单的示例,展示如何使用SDK进行标识解析:

// Java 示例
import com.example.industrialresolver.Resolver;

public class QuickStart {
    public static void main(String[] args) {
        // 初始化SDK
        Resolver resolver = new Resolver("YOUR_API_KEY");
        
        // 解析标识
        String identifier = "urn:oid:1.2.3.4.5";
        ResolveResult result = resolver.resolve(identifier);
        
        // 处理结果
        System.out.println("解析结果: " + result.toString());
    }
}

API 参考

我们提供了RESTful API,支持标识编码、解析、数据查询等功能。

认证

所有API请求都需要在HTTP请求头中包含API密钥:

Authorization: Bearer YOUR_API_KEY

主要API端点

端点 方法 说明
/api/v1/resolve/{identifier} GET 解析标识,获取关联信息
/api/v1/identifiers POST 创建新标识
/api/v1/identifiers/{identifier} PUT 更新标识信息
/api/v1/batches POST 批量处理标识

SDK 使用指南

我们的SDK封装了底层API调用,提供了更加友好的编程接口。

Java SDK

支持JDK 8及以上版本

查看文档

Python SDK

支持Python 3.6及以上版本

查看文档

Node.js SDK

支持Node.js 12及以上版本

查看文档

示例代码

以下是一些常见场景的示例代码,帮助您快速上手。

标识解析示例

// 示例代码 - 标识解析
Resolver resolver = new Resolver("YOUR_API_KEY");

// 单个标识解析
String identifier = "urn:oid:1.2.3.4.5";
ResolveResult result = resolver.resolve(identifier);

// 批量标识解析
List<String> identifiers = Arrays.asList(
    "urn:oid:1.2.3.4.5",
    "urn:oid:1.2.3.4.6",
    "urn:oid:1.2.3.4.7"
);
Map<String, ResolveResult> results = resolver.batchResolve(identifiers);

标识注册示例

// 示例代码 - 标识注册
Resolver resolver = new Resolver("YOUR_API_KEY");

// 创建标识属性
Map<String, Object> attributes = new HashMap<>();
attributes.put("productName", "智能设备A");
attributes.put("manufacturer", "示例制造商");
attributes.put("productionDate", "2023-06-15");

// 注册新标识
String prefix = "urn:oid:1.2.3.4";
RegisterResult result = resolver.register(prefix, attributes);
String newIdentifier = result.getIdentifier();
System.out.println("新创建的标识: " + newIdentifier);

常见问题

如何获取API密钥?

登录开发者控制台,在「API管理」页面可以创建和管理您的API密钥。

API调用有限制吗?

是的,根据您的账户等级,有不同的API调用频率限制。详细信息请参阅「计费与限制」文档。

支持哪些标识格式?

我们支持OID、Handle、DOI等多种标识格式,详细请参阅「标识格式规范」文档。

如何报告问题或获取支持?

您可以通过开发者论坛提问,或者通过support@example.com联系我们的技术支持团队。

需要更多帮助?

我们的技术支持团队随时为您提供帮助