API文档

通过脉链API,将人脉管理能力集成到您的应用中

API概述

脉链API提供了一套完整的RESTful接口,允许开发者将脉链的人脉管理和分析能力集成到自己的应用中。通过API,您可以:

  • 管理用户的数字名片和联系人信息
  • 访问人脉分析和评分功能
  • 自动化人脉维护和互动流程
  • 获取人脉网络的可视化数据
注意: 使用API需要先申请开发者账号并获取API密钥。

认证与授权

所有API请求都需要通过OAuth 2.0进行认证。请按照以下步骤获取访问令牌:

获取访问令牌
POST https://api.mailink.ai/oauth/token
Content-Type: application/json

{
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "grant_type": "client_credentials"
}

获取令牌后,在所有API请求的Header中添加:

Authorization: Bearer YOUR_ACCESS_TOKEN
安全提示: 请妥善保管您的API密钥和访问令牌,不要在客户端代码中暴露它们。

API端点

联系人管理

获取联系人列表
GET https://api.mailink.ai/v1/contacts
Parameters:
  - page: 页码 (默认: 1)
  - limit: 每页数量 (默认: 20)
  - sort: 排序字段 (可选: name, created_at, score)
  - order: 排序方式 (asc, desc)
创建新联系人
POST https://api.mailink.ai/v1/contacts
Content-Type: application/json

{
  "name": "张三",
  "email": "zhangsan@example.com",
  "phone": "13800138000",
  "company": "示例公司",
  "position": "产品经理",
  "tags": ["技术", "产品"],
  "notes": "在会议上认识的"
}
获取联系人详情
GET https://api.mailink.ai/v1/contacts/{contact_id}

人脉分析

获取联系人评分
GET https://api.mailink.ai/v1/contacts/{contact_id}/score
获取人脉网络分析
GET https://api.mailink.ai/v1/network/analysis
Parameters:
  - depth: 网络深度 (默认: 2)
  - metrics: 分析指标 (可选: centrality, density, clusters)
获取人脉推荐
GET https://api.mailink.ai/v1/recommendations
Parameters:
  - type: 推荐类型 (可选: connect, follow_up, introduce)
  - limit: 推荐数量 (默认: 5)

数字名片

获取用户名片
GET https://api.mailink.ai/v1/cards/{user_id}
更新用户名片
PUT https://api.mailink.ai/v1/cards/{user_id}
Content-Type: application/json

{
  "name": "李四",
  "title": "技术总监",
  "company": "脉链科技",
  "bio": "10年技术管理经验",
  "social_links": {
    "linkedin": "https://linkedin.com/in/lisi",
    "wechat": "lisi_wechat"
  },
  "contact_info": {
    "email": "lisi@example.com",
    "phone": "13900139000"
  }
}
获取名片访问统计
GET https://api.mailink.ai/v1/cards/{user_id}/stats
Parameters:
  - period: 统计周期 (day, week, month, year)

错误处理

API使用标准HTTP状态码表示请求结果。常见的错误码包括:

状态码 描述
400 请求参数错误
401 未授权,需要有效的访问令牌
403 权限不足,无法访问请求的资源
404 请求的资源不存在
429 请求过于频繁,超出API限制
500 服务器内部错误

错误响应格式示例:

{
  "error": {
    "code": "invalid_parameter",
    "message": "参数'email'格式不正确",
    "details": {
      "field": "email",
      "reason": "format"
    }
  }
}

开发者资源

我们提供丰富的资源帮助您快速集成脉链API

SDK

多语言SDK,简化API集成

下载SDK

示例代码

常见场景的实现示例

查看示例

开发者社区

交流经验,获取支持

加入社区