IPS4提供了广泛的REST API，为第三方应用程序和网站提供了一种使用和创建数据的方法。你可以做的事情包括创建新主题，注册新成员，更新成员信息，创建商业订单等等。

每个IPS4社区都提供了自己的API实例。这意味着，如果您构建社区管理员可以在社区启用的应用程序中，每个社区都需要为您的集成创建API密钥，并且REST请求直接发送给该社区 - 和不到由我们操作的中央API位置。

有两种方法对REST API的请求进行身份验证:使用API密钥(所有版本)或使用OAuth(4.3及以上版本)。

使用API​​键时，所有数据都可用，并且可以执行所有操作。例如，如果您发送API请求获得/论坛/主题，社区里的每一个话题都会有结果;如果你发送一个API请求发布/论坛/主题您可以将主题创建为任何用户在社区。因此，您始终保持API键的秘密非常重要，并且只授予对您打算使用的端点的访问权限。

与API键不同，在使用OAuth访问REST API时，您将提供已被授予特定用户*的访问令牌，并且只有用户可以看到的数据以及用户可以执行的操作。例如，如果您发送API请求获得/论坛/主题，只有通过认证的用户可以看到的论坛主题才会出现在结果中;如果你发送一个API请求发布/论坛/主题主题将作为经过身份验证的用户创建，并且不能更改。

有些端点仅在使用一种或另一种方法时可用。例如,/核心/我获取关于经过身份验证的用户的信息，因此只能在使用OAuth进行身份验证时使用。与此同时,POST /论坛/论坛创建一个论坛，这是一个站点级别的操作，因此只能使用API密钥*验证。有些端点虽然对两种方法都可用，但可能接受不同的请求参数，或者对不同的方法有不同的响应参数，这些将在文档中解释。

*如果你熟悉OAuth，更喜欢使用它来验证API密钥，你也可以使用客户端凭证验证，这将工作类似于使用API密钥，提供对API的完全访问，而不是作为一个特定的用户。

使用API密钥(很简单)

社区管理员可以在Admincp→系统→REST＆OAuth→API键中生成API键。每个API键都需要配置为其可以访问的端点。

在您的请求中提供API密钥的方法取决于社区运行的服务器。推荐的方法是HTTP基本验证。将API键作为用户名发送，没有密码。例如:

<？PHP $ CommunityURL.＝“https://www.example.com/ips4/”；apiKey美元＝'C7A349A1629F02CD2855A58D77646F6D'；美元的端点＝“核心/你好”；$卷曲＝curl_init（communityUrl美元．“api”．美元的端点）;curl_setopt_array（$卷曲，数组（curlopt_returntransfer.＝＞真的，CURLOPT_HTTPAUTH＝＞CURLAUTH_BASIC，CURLOPT_USERPWD＝＞”{apiKey美元}:“curlopt_useragent.＝＞“MyUserAgent / 1.0”））;$响应＝curl_exec.（$卷曲）;

如果PHP作为CGI模块运行(可以通过检查服务器的phpinfo输出来确认)，那么服务器可能无法看到授权头。在Invi狗万最低限额sion Community 4.5及以上版本中，您可以发送带有相同base64编码凭证的X-Authorization头，否则您将需要通过发送您的API密钥作为钥匙参数。例如:

<？PHP $ CommunityURL.＝“https://www.example.com/ips4/”；apiKey美元＝'C7A349A1629F02CD2855A58D77646F6D'；美元的端点＝“核心/你好”；/*首先尝试这个方法(需要Invision Community 4.5或更狗万最低限额高)*/$卷曲＝curl_init（communityUrl美元．“api”．美元的端点）;curl_setopt_array（$卷曲，数组（curlopt_returntransfer.＝＞真的，curlopt_useragent.＝＞“MyUserAgent / 1.0”，CURLOPT_HTTPHEADER＝＞数组（“X-Authorization:”．base64_encode（“{$ AccessToken}：”）），））;$响应＝curl_exec.（$卷曲）;/* OR，如果它不工作，使用这个方法*/$卷曲＝curl_init（communityUrl美元．“api”．美元的端点．'？关键= '．apiKey美元）;curl_setopt_array（$卷曲，数组（curlopt_returntransfer.＝＞真的，curlopt_useragent.＝＞“MyUserAgent / 1.0”））;$响应＝curl_exec.（$卷曲）;

对于所有GET请求，在查询字符串中提供参数。对于PUT和POST请求，所有参数都应该发送body中编码的Form URL。

来自API的响应是总是json编码的。

当遇到错误时，你会收到这样的响应:

{"errorCode": "3S290\/7"， "errorMessage": "INVALID_API_KEY"}

每个端点可能的错误代码/消息在此文档参考中有详细说明。除了端点特定的错误外，还可能返回以下全局错误:

这是一个简单的代码片段，显示给了一个呼叫/核心/你好端点。

<？PHP $ CommunityURL.＝“http://www.example.com/ips4/”；apiKey美元＝'C7A349A1629F02CD2855A58D77646F6D'；$卷曲＝curl_init（communityUrl美元．'api / core / hello'）;curl_setopt_array（$卷曲，数组（curlopt_returntransfer.＝＞真的，CURLOPT_HTTPAUTH＝＞CURLAUTH_BASIC，CURLOPT_USERPWD＝＞”{apiKey美元}:“curlopt_useragent.＝＞“MyUserAgent / 1.0”））;$响应＝curl_exec.（$卷曲）;echo $响应；

{"communityName": "IPS Community Suite"， "communityUrl": "http:\/\/localhost:8888\/ips4\/"， "ipsVersion": "4.1.6"}