Issuu提供了一个简单的基于rest的界面,使其能够快速、容易地开始使用。
你需要做的第一件事是申请一个API密匙.我们唯一需要的是,你有一个活跃的Issuu帐户,你给我们一点关于你想建立的应用程序的信息。我们非常好奇,想看看你能想出什么很酷的东西!
请记住,API密钥应与任何其他密码一样对待。使用它,您可以执行从ISSU帐户中删除信息和文档等操作。不要向任何人透露或分享你的API密钥!
在发出请求之前,必须选择一个API方法。根据您想调用的方法,您需要选择正确的端点。
作为一个规则,所有请求都必须向以下端点发出:
http:/ / api.issuu.com/1_0
当使用HTTP GET请求时,参数应该作为URL的一部分发送,或者在HTTP正文中发送HTTP POST请求。
但每一条规则都需要例外!上载文档时,必须使用特殊端点:
http:/ / upload.issuu.com/1_0
当上传文件时,你必须使用编码多部分/表单数据的HTTP POST。
要对Issuu API执行操作,有三个参数必须始终包含在请求中:
您可以自由选择使用HTTP GET或HTTP POST发送参数。
http://api.issuu。com/1_0吗?apiKey =< apiKey >签名=<签名>&行动=<法>
注意:所有发送到Issuu API的数据必须是UTF-8编码的。API返回的所有数据将使用UTF-8编码。以不同的编码提交数据将导致请求失败,错误代码为201“无效的字段格式”。看到步骤5:处理错误对于常见的错误码。
当使用POST时,你需要设置所有API调用的Content-Type头为"x-www-form-urlencoded",除非上传文件。
以POST参数发送数据:
帖子/ 1 _0HTTP / 1.1主办: api.issuu.com内容类型: x-www-form-urlencoded密码>
上传API只处理编码为“多部分/表单数据”的请求。看到issuu.document.upload获取详细信息。
发送文件内容和数据:
帖子/ 1 _0HTTP / 1.1主办: upload.issuu.com内容类型:多部分/格式;边界= XXXXXXXXXX密码>
强烈建议在提交HTTP请求时使用标准库来处理编码。如果未正确指定内容类型,将无法识别发布的参数,并返回错误代码200“缺少必填字段”。
GET请求不能包含Content-Type报头。
两个可选参数用于指定响应格式:
当调用数据列表方法之一时,强烈建议使用可选参数responseParams将响应限制为仅包含应用程序所需的参数。
来自API服务器的响应对于XML和JSON/JSONP格式都具有相同的结构。响应的实际有效负载被包装在一个“rsp”元素中,一个名为“stat”的属性指示请求是否成功。
XML
<负责统计=“ok”><!-有效载荷到这里->负责>
JSON
{“负责”:{“_content”: {/* payload到这里*/},“统计”:“ok”} }密码>
即使请求失败,响应的HTTP状态码也总是200 'OK'。
在出现错误的情况下,stat属性的值为“fail”。响应的有效负载是一个带有“code”和“message”属性的错误对象。如果错误是由一个或多个格式错误的请求参数引起的,可选的“field”属性将指示第一个违规参数的名称。XML
<负责统计=“失败”><错误密码=“代码”消息=“[消息]”场=“(场)”/>负责>
JSON
{“负责”:{“_content”:{“错误”:{“代码”:“代码”,“消息”:“[消息]”,“字段”:“(场)”} },“统计”:“失败”} }密码>
下表列出了最常见的错误:
代码 | 消息 | 解释 |
---|---|---|
009 | 认证要求 | 检查请求中是否包含API密钥参数 |
010 | 无效的API密钥 | 检查API密钥是否已正确提交。它应该由32个字符组成 |
011 | 坏的签名 | 检查你的请求签署过程 |
200 | 缺少必填字段 | 检查“field”属性,查看丢失的字段 |
201 | 无效的字段格式 | 检查您正在调用的方法的文档。某些字段有特殊的格式要求。还要检查是否使用UTF-8编码 |
205 | 文件大小太大 | 当前上传的文件大小不能超过100mb |