WordPress HTTP API由许多功效组成,可以辅助开发职员更轻松地进行HTTP挪用。不再需要摆弄file_get_contents或cURL,只需一个统一的界面即可。与第三方API进行交互异常好,尤其是与Twitter,Facebook,MailChimp等其他具有REST功效的API交互时。
- HTTP的基础
- 关于Restful API
- 使用WordPress HTTP API
HTTP基础
我们都已经知道HTTP的现实应用。现实上,若是这是您第一次接见Web,那么您已经看到HTTP施展了神奇的作用。HTTP是一种网络协议,用于跨Interweb转达所有文件和数据(资源)。
基本上有两个部门:HTTP请求和HTTP响应(即事务)。请求和响应在结构上都异常相似,它们都有四个部门:
- 起始行(请求行)
- 零个或多个题目行
- 空行
- 可选的body内容
The Initial Line起始行
请求使用起始行发送三个信息:方式名称,路径和HTTP版本。例如,在查看闪电博博客页面时,您会在请求的第一行看到它。
响应还提供了三部门信息,只管有些差异:HTTP版本,响应代码和响应形貌。向闪电博网站博客发出请求时,它将发送带有以下起始行行的HTTP响应:
Headers标头
标头包罗有关请求或响应的种种信息。HTTP 1.1界说了46种报头类型,但仅一种(仅用于请求)是必须的“主机”报头。如打开闪电博网站的博客页面,Chrome开发职员工具中的屏幕截图,其中显示了一些标头以及发送给闪电博网站的请求:
Header标头示例
Body
Body通常包罗有关所请求资源的数据。若是您向闪电博网站博客发送GET请求,则应该收到在主体内容中出现页面(资源)所需的HTML。
更多信息
这就是您现在需要领会的所有关于HTTP的信息。我们将主要集中在方式名称(GET,POST等),标头和主体上。若是您想领会更多信息,推荐阅读James Marshall对HTTP的注释,这是一篇异常不错的关于HTTP入门的文章。
关于Restful APIs
Restful API或REST方式旨在提供一种与应用程序进行交互的简朴且尺度的方式。它通常与HTTP连系使用,以确定一个异常易于明白的交互系统。它基于路径和HTTP verbs。
HTTP verbs与我们之前看到的方式名称相同,最常见的是:GET,POST,PUT,DELETE。我以为PUT是唯一的模棱两可的工具,可以将其视为更新下令。将这些verbs与路径一起使用时,我们可以构建一个有意义的系统:
将用于检索ID为1的文章。
将用于删除统一文章。我们还可以使用
来更新它,在请求正文和标头中提供相关信息。
您可以看到,仅通过将HTTP版本附加到上面的代码中,我们现实上就有了HTTP事务的起始行,这是该系统云云壮大的缘故原由之一。
使用WordPress HTTP API
拥有所有这些知识,我们可以轻松掌握WordPress HTTP API的事情方式。发出请求和阻挡响应的四种方式是:
-
wp_remote_get()
-
wp_remote_post()
-
wp_remote_head()
-
wp_remote_request()
前两个函数是不言自明的,它们在请求中划分使用GET和POST方式。第三个函数使用HEAD方式,我们还没有讨论过。此方式仅用于检索响应的标头。若是我们只需要一些关于资源的元数据,则可以节约许多开销。最后一个函数是通用函数,您可以在函数的参数中指定要使用的方式。
我们可以使用五个附加函数来检索响应的特定部门。这些基本上是指导我们吸收到的大量数据的捷径:
-
wp_remote_retrieve_body()
-
wp_remote_retrieve_header()
-
wp_remote_retrieve_headers()
-
wp_remote_retrieve_response_code()
-
wp_remote_retrieve_response_message()
第一个HTTP请求
让我们通过从闪电博网站博客中获取标头信息来进行快速测试。您可以在插件或主题中的任何位置执行此操作,然则显然应该在测试环境中进行操作,以确保不会在实时站点上输出不需要的文本。
如何在WordPress网站合理地使用GIF动画图片
$response = wp_remote_head( 'https://www.wbolt.com/blog' ); var_dump( $response )
从响应中可以看到,body部门为空(由于我们使用的是HEAD方式),而且显示了所有题目。要仅获取标头而不包罗所有其他数组成员,我们可以使用
函数。
array (size=5) 'headers' => array (size=13) 'server' => string 'nginx' (length=5) 'date' => string 'Wed, 22 Jul 2015 14:22:07 GMT' (length=29) 'content-type' => string 'text/html; charset=UTF-8' (length=24) 'connection' => string 'close' (length=5) 'vary' => string 'Accept-Encoding' (length=15) 'x-pingback' => string 'https://www.wbolt.com/xmlrpc.php' (length=29) 'x-powered-by' => string 'HHVM/3.8.0' (length=10) 'link' => string '; rel="https://github.com/WP-API/WP-API"' (length=68) 'x-frame-options' => string 'DENY' (length=4) 'x-content-type-options' => string 'nosniff' (length=7) 'strict-transport-security' => string 'max-age=31536000' (length=16) 'x-wbolt-cache' => string 'HIT' (length=3) 'content-encoding' => string 'gzip' (length=4) 'body' => string '' (length=0) 'response' => array (size=2) 'code' => int 200 'message' => string 'OK' (length=2) 'cookies' => array (size=0) empty 'filename' => null
领会API
Twitter API接口
对于开发职员而言,最大障碍是,使API挪用正常事情所需的大量新内容。您需要领会HTTP,如何发出请求以及如何准确进行身份验证,否则,每个挪用都市失败。让我们看一下Twitter API的示例,由于它们提供了异常详细的文档。
我们将研究仅应用程序身份验证(这是一个更简朴的流程),根据Twitter建议的相同步骤进行操作。在最先之前,请确保确定一个Twitter应用程序。
您应该可以将下面的代码添加到主题或插件中的任何位置,并请确保使用测试站点!
第1步:编码CONSUMER KEY和SECRET
确定应用程序后,你应该会获取到一个CONSUMER KEY和CONSUMER SECRET。为了使事情变得容易,让我们确定一个常量,为我们保留这些信息。
define( 'TWITTER_CONSUMER_KEY', '12disnir382jeqwdasd23wdasi' ); define( 'TWITTER_CONSUMER_SECRET', '23wdajskduhtrq2c32cuq9r8uhuf' )
在文档中列出了确定这些文件的编码版本的三个步骤:
- URL编码KEY和SECRET
- 用冒号毗邻它们
- Base64编码整个字符串
在PHP中,这很容易做到!
$key = urlencode( TWITTER_CONSUMER_KEY ); $secret = urlencode( TWITTER_CONSUMER_SECRET ); $concatenated = $key . ':' . $secret; $encoded = base64_encode( $concatenated );
第2步:获取承载token
您无需使用现实密码,而是向Twitter发送您的编码字符串(使用您的API凭证),而且会收到一个暂且通行证,该通行证在一准时间内有用。为此,我们将发出一个HTTP请求,这是Twitter所说的:
- 该请求必须是HTTP POST请求。
- 该请求必须包罗值为Basic的Authorization标头。
- 该请求必须包罗Content-Type标头,其值是application/x-www-form-urlencoded;charset=UTF-8。
- 请求的正文必须为grant_type = client_credentials。
让我们从基础最先。需要POST请求,因此我们将使用
。该函数带有参数;第一个是URL,第二个包罗可选参数。该网站为
,我们将使用第二个参数来处置所有其他要求。
$args = array( 'headers' => array( 'Authorization' => 'Basic ' . $encoded, 'Content-Type' => 'application/x-www-form-urlencoded;charset=UTF-8' ), 'body' => 'grant_type=client_credentials' ); $response = wp_remote_post( 'https://api.twitter.com/oauth2/token', $args );
标头需要作为数组添加,标头类型是键,值是数组成员的值;主体应该是一个字符串。若是乐成,您应该会看到与以下类似的响应。
array (size=5) 'headers' => array (size=23) 'cache-control' => string 'no-cache, no-store, must-revalidate, pre-check=0, post-check=0' (length=62) 'content-disposition' => string 'attachment; filename=json.json' (length=30) 'content-encoding' => string 'deflate' (length=7) 'content-length' => string '142' (length=3) 'content-type' => string 'application/json;charset=utf-8' (length=30) 'date' => string 'Wed, 22 Jul 2015 14:47:37 GMT' (length=29) 'expires' => string 'Tue, 31 Mar 1981 05:00:00 GMT' (length=29) 'last-modified' => string 'Wed, 22 Jul 2015 14:47:37 GMT' (length=29) 'ml' => string 'A' (length=1) 'pragma' => string 'no-cache' (length=8) 'server' => string 'tsa_b' (length=5) 'set-cookie' => string 'guest_id=v1%3A14375720938219946; Domain=.twitter.com; Path=/; Expires=Fri, 21-Jul-2017 14:47:37 UTC' (length=100) 'status' => string '200 OK' (length=6) 'strict-transport-security' => string 'max-age=631138519' (length=17) 'x-connection-hash' => string 'd8b10926f99dwef93rd7edbe5a71a97a' (length=32) 'x-content-type-options' => string 'nosniff' (length=7) 'x-frame-options' => string 'SAMEORIGIN' (length=10) 'x-response-time' => string '34' (length=2) 'x-transaction' => string 'ef0ebwefweece62ef' (length=16) 'x-tsa-request-body-time' => string '0' (length=1) 'x-twitter-response-tags' => string 'BouncerCompliant' (length=16) 'x-ua-compatible' => string 'IE=edge,chrome=1' (length=16) 'x-xss-protection' => string '1; mode=block' (length=13) 'body' => string '{"token_type":"bearer","access_token":"AAAAAAAAAAAAAAAAAAAAAFoafQAAAAAAqg%2BxmuH83hjsod6crH5bKTUX9Arc%3D5dWpp0XCTDjyiXxMC7LDLg8JbzPdGlCsJi2R1qjY1FMksTAFyG"}' (length=155) 'response' => array (size=2) 'code' => int 200 'message' => string 'OK' (length=2) 'cookies' => array (size=1) 0 => object(WP_Http_Cookie)[303] public 'name' => string 'guest_id' (length=8) public 'value' => string 'v1:143757645770219946' (length=21) public 'expires' => int 1500648457 public 'path' => string '/' (length=1) public 'domain' => string '.twitter.com' (length=12) 'filename' => null
所有这些的主要highlight是可以在响应正文中找到的接见令牌。现在让我们使用WordPress函数来检索它。参照前面的示例,我们可以使用以下代码来获取接见令牌:
$body = wp_remote_retrieve_body( $response ); $body = json_decode( $body, true ); $access_token = $body['access_token'];
步骤3:使用不记名token
最后一步就是在所有其他API挪用中使用此承载令牌。我们需要将其添加为“Authorization”标头,其值是:
。让我们做一个简朴的API挪用,它将使用user_timeline路径检索用户的最新推文。
最后,该
变量将包罗一个tweet数组。您可以使用此数组的种种属性来显示推文或处置数据。
$url = 'https://api.twitter.com/1.1/statuses/user_timeline.json?screen_name=danielpataki&count=3'; $args = array( 'headers' => array( 'Authorization' => 'Bearer ' . $access_token, ), ); $response = wp_remote_get( $url, $args ); $tweets = json_decode( wp_remote_retrieve_body($response), true )
小结
如您所见,使用WordPress HTTP API毗邻到外部服务并不难。当今的许多现代API都是基于相同的REST原理构建的-一旦您学习了一个REST原理,您就会很快地掌握其他REST原理。
请记着,每当文档要求您使用正文时,请使用正文,而且在需要题目时,只需添加所需的数目即可。然后,查看响应,将其转换为数组,获取所需的数据并使用它,就这么简朴。
若是以前有人使用过稀奇好或欠好的API,或者您有一些使用WordPress HTTP API的技巧和窍门,请在谈论中告诉我们!
炒冷饭也是做好SEO的一种手段