新手指南-易信开放平台

Oauth API 新手指南

Oauth API是易信为你提供的获取易信用户相应授权信息的API，当你获得用户授权（OAuth认证）后通过以下API可以轻松的访问相应的资源。

1. 准备

1. 如果您没有易信账户，请下载易信客户端，并注册一个易信帐号。
2. 使用易信帐号登录开放平台，转到应用管理页面，添加一个新应用。
3. 填写你的应用资料（Android平台IOS平台可以留空，服务器回调地址为您的服务器接收Authorization Code地址），完成后保存，提交审核(资料不全的应用无法使用Oauth接入) ，你会获得一个AppID。
4. 获取用户授权（使用APP SDK获取授权使用web网页获取授权）

2. 相关API

注：以下所有接口都需要带上access token，参数名"access_token"。

2.1 获取用户信息接口

功能：用户可通过此接口来获取自己的相关用户信息

是否需要oauth认证：是

频次限制：是

接口请求参数：access_token，你通过易信OAuth授权之后获取到的token

Get https://open.yixin.im/api/userinfo

返回结果:JSON示例

{ "userinfo": { "nick": "608004L", "icon": "http://nos.netease.com/yixinpublic/pr_LDUGzNR_Nwm6gauFFhnCIQ==_1376031212_119", "accountId": "c522693fded20225adda2c3e417924a4" }, "code": 1 }

返回字段说明

返回值字段	字段类型	字段说明
nick	string	用户昵称
icon	string	用户头像
accountId	string	用户ID

2.2 获取用户好友列表接口

功能：用户可通过此接口来获取自己的好友信息

是否需要oauth认证：是

频次限制：是

接口请求参数：access_token，你通过易信OAuth授权之后获取到的token

Get https://open.yixin.im/api/friendlist

返回结果:JSON示例

{ "friendlist": [ { "nick": "马", "icon": null, "accountId": "8d6c77a7403712f5797ac8a2a111c11d" }, { "nick": "兔子", "icon": "http://nos.netease.com/yixinpublic/pr_b2ja3pblsr9kloljrfxqwg==_1383718660_968", "accountId": "72fe7302da1e36e27ed487e13b161b61" }, { "nick": "man", "icon": null, "accountId": "41f82e5baa7f4e8fb09fab656f3cec69" }, ], "code":1 }

返回字段说明

返回值字段	字段类型	字段说明
nick	string	用户昵称
icon	string	用户头像
accountId	string	用户ID

2.3 发送到用户易信朋友圈接口

功能：用户可通过此接口来发送信息到自己的朋友圈

是否需要oauth认证：是

频次限制：是

POST https://open.yixin.im/api/sendcirclemsg

接口请求参数：

字段	类型	说明
access_token	string	你通过易信OAuth授权之后获取到的token
content	json 字符串（UTF8）	JSON格式的信息

content数据封装: JSON示例

(1) 图文类型

{ "ps": "ddgg ", "desc": "朱哲琴", "image": "http://nos.netease.com/yixinpublic/pr_ezqerif_wrtieb39mrdj3w==_1385019306_3704", "title": "月出MOONRISE", "url": "http://music.163.com/song/27955410/", "type": "webpage" }

(2) 文本类型

{ "ps": "gjxcbbjfk", "text_content": "这段文字发送自易信SDK示例程序", "desc": "这段文字发送自易信SDK示例程序", "type":"text" }

(3) 大图类型

{ "ps": "ddgg ", "image": "http://nos.netease.com/yixinpublic/pr_ezqerif_wrtieb39mrdj3w==_1385019306_3704", "title": "月出MOONRISE", "url": "http://music.163.com/song/27955410/", "type":"image" }

(4) 音乐类型

{ "ps": "ddgg ", "desc": "朱哲琴", "image":"http://nos.netease.com/yixinpublic/pr_ezqerif_wrtieb39mrdj3w==_1385019306_3704", "music_url": "http://m1.music.126.net/IjQ3JRJ1V6ybQIa5K86gXg==/5825212603979308.mp3", "title": "月出MOONRISE", "url": "http://music.163.com/song/27955410/", "type":"music" }

(5) 视频类型

{ "ps": "cssdvh the ", "desc": "Video Long Very LonLong Very Long Very Long ", "image":"http://nos.netease.com/yixinpublic/pr_nkaserv0nyhpr3o7-phupa==_1385108739_22593", "title": "Vidong Very Loy Long Very Long Very Long", "url": "http://3g.163.com/ntes/special/0034073A/wechat_article.html?docid=978FP00H00014AED", "type":"video" }

content参数说明

ps	评论内容
desc	内容的描述
image	缩略图的url
title	内容的标题
url	点击跳转的url
type	类型见下表
music_url	音乐url（music类型特有）
text_content	文本内容（text类型特有）

Type字段填写（必须为以下之一，否则发送失败）

webpage	图文类型
text	纯文本
image	大图
music	音乐
video	视频

返回结果:JSON示例

{ "code":1 }

返回字段说明

code 1 成功。

说明：发送的内容中，来源信息会根据认证的appid自动添加。

2.4 发送易信点对点消息接口

功能：用户可通过此接口来发送信息到自己的某个好友

是否需要oauth认证：是

频次限制：是

POST https://open.yixin.im/api/sendp2pmsg

接口请求参数：

字段	类型	说明
access_token	string	你通过易信OAuth授权之后获取到的token
toAccountId	string	用户的某个好友id
content	json 字符串（UTF8）	JSON格式的信息

content数据封装: JSON示例

(1) 图文类型

{ "desc": "朱哲琴", "image": "http://nos.netease.com/yixinpublic/pr_ezqerif_wrtieb39mrdj3w==_1385019306_3704", "title": "月出MOONRISE", "url": "http://music.163.com/song/27955410/", "type":"webpage" }

(2) 文本类型

{ "text_content": "这段文字发送自易信SDK示例程序", "desc": "这段文字发送自易信SDK示例程序", "type": "text" }

(3) 大图类型

{ "image": "http://nos.netease.com/yixinpublic/pr_ezqerif_wrtieb39mrdj3w==_1385019306_3704", "title": "月出MOONRISE", "url": "http://music.163.com/song/27955410/", "type": "image" }

(4) 音乐类型

{ "desc": "朱哲琴", "image":"http://nos.netease.com/yixinpublic/pr_ezqerif_wrtieb39mrdj3w==_1385019306_3704", "music_url": "http://m1.music.126.net/IjQ3JRJ1V6ybQIa5K86gXg==/5825212603979308.mp3", "title": "月出MOONRISE", "url": "http://music.163.com/song/27955410/", "type": "music" }

(5) 视频类型

{ "desc": "Video Long Very LonLong Very Long Very Long ", "image":"http://nos.netease.com/yixinpublic/pr_nkaserv0nyhpr3o7-phupa==_1385108739_22593", "title": "Vidong Very Loy Long Very Long Very Long", "url": "http://3g.163.com/ntes/special/0034073A/wechat_article.html?docid=978FP00H00014AED", "type":"video" }

注意事项：toAccountId 必须是获得用户好友列表中的某个好友的id

返回结果:JSON示例

{ "code":1 }

返回字段说明

code 1 成功。

2.5 收藏到易信接口

功能：用户可通过此接口来添加到易信收藏

是否需要oauth认证：是

频次限制：是

POST https://open.yixin.im/api/addfav

接口请求参数：

字段	类型	说明
access_token	string	你通过易信OAuth授权之后获取到的token
content	json 字符串（UTF8）	JSON格式的信息

content数据封装: JSON示例

(1) 文本类型

{ "text_content": "收藏的内容写在这里", "type":"text" }

(2) 大图类型

{ "image": "http://nos.netease.com/yixinpublic/pr_ezqerif_wrtieb39mrdj3w==_1385019306_3704", "url": "http://music.163.com/song/27955410/", "type":"image" }

content参数说明

image	缩略图的url
url	点击跳转的url
type	类型见下表
text_content	文本内容（text类型特有）

Type字段填写（必须为以下之一，否则发送失败）

text	纯文本
image	大图

返回结果:JSON示例

{ "code":1 }

返回字段说明

code 1 成功。

3. Oauth异常

返回示例

{"error":"invalid_token","error_description":"Invalid token: 234324"}

4. 易信用户头像缩放处理

功能：因上述接口获取到的易信用户头像可能是原图，未经压缩处理，第三方客户端或应用可通过此API获取指定长宽的缩略图。
仅限NOS域名的图像url使用

是否需要oauth认证：否

频次限制：是

Get ${NOS_Picture_URL}?imageView&thumbnail=${thumbnail}&pixel=${pixel}&crop=${crop}&quality=${quality}&type=${type}&watermark=${watermark}&axis={axis}

参数	描述	是否必须
imageView	对图片进行缩略，裁剪等操作	Yes
thumbnail	thumbnail指定缩略图片的宽和高，有以下几种格式： Width x Height ：普通缩略（内缩略） Width x 0 ：限定宽度，高度自适应（内缩略） 0 x Height ：限定高度，宽度自适应（内缩略） Width y Height ：裁剪缩略 Width z Height ：普通大边缩略（外缩略）对于形如 Width x 0 和 0 x Height 的格式，表示限定图片的一边，另一边自适应。例如：480x0，表示固定宽度为480，高度自适应。取值范围：[0-4096]	No
pixel	指定缩略图的最终像素，NOS将图片缩略为指定像素大小，如果原图像素小于指定像素，则返回原图举例：对于原图为200200的图片，若指定pixel=10000，则会将图片缩略为100100 类型：整型取值范围：[100-16777216]	No
crop	图片裁剪参数。 &crop=x_y_width_height 表示从原坐标(x, y)处截取width*height的子图片	No
quality	返回图片处理的质量类型：整型取值范围：[0-100], 0代表质量最低，100代表质量最高默认值：85	No
type	返回图片的类型取值：”jpg”, “jpeg”, “png”, “bmp” 默认返回原图类型	No
watermark	文字水印, 采用URLBase64编码，编码后最长64字节类型：字符串水印图片必要条件：高度不低于200px 宽度不低于300px	No
axis	该参数只针对裁剪缩略（ Width y Height ）对于裁剪缩略，NOS内部处理过程为先缩略，后裁剪，axis表示裁剪得到的小图在缩略图中的位置。取值范围：[0-10], 0表示最顶端，10表示最底端。（仅支持高不支持宽）默认值：5	No

注意事项：

1. 若同时指定缩略（thumbnail）、裁剪（crop）和像素缩略（pixel）参数，只有一个参数有意义，这三个参数的优先级为pixel > crop > thumbnail。即若同时指定了pixel和crop，crop参数无意义，同时指定crop和thumbnail，thumbnail无意义，同时指定三个参数，crop和thumbnail均无意义；

2. axis参数只针对裁剪缩略（WidthyHeight），在其他情况下指定该参数无意义；

示例：

http://nos.netease.com/yixinpublic/pr_ip9q6mhqugkh1se-pntsjq==_1386831363_150075?imageView&thumbnail=20z20

返回结果:

在请求执行成功时，直接返回处理之后的图片。

在请求执行失败时，返回出错信息和对应的HTTP状态码。