Rumah >Tutorial CMS >WordTekan >OAuth, Twitter, WordPress HTTP API dan anda
3
Takeaways Key
OAuth adalah protokol pengesahan yang menawarkan cara yang lebih selamat untuk berinteraksi dengan data yang dilindungi, membolehkan aplikasi bertindak atas nama pengguna tanpa berkongsi kata laluan mereka. Twitter menggunakan OAuth untuk membenarkan permintaan HTTP ke APInya.
OAuth adalah protokol pengesahan yang menyediakan cara yang mudah, lebih selamat dan lebih selamat untuk menerbitkan dan berinteraksi dengan data yang dilindungi. Ia membolehkan pengguna meluluskan aplikasi untuk bertindak bagi pihak mereka tanpa berkongsi kata laluan mereka.
Jika anda menyimpan data yang dilindungi pada nama pengguna anda, mereka tidak sepatutnya menyebarkan kata laluan mereka di seluruh web untuk mendapatkan akses kepadanya. Sebaliknya, anda boleh menggunakan OAuth untuk memberi pengguna akses kepada data mereka, sambil melindungi kelayakan akaun mereka.
Run-down mengenai bagaimana permintaan HTTP ke Twitter dibuat dengan pengesahan OAuth akan dijelaskan ketika kami kod kelas PHP.
Pertama, pergi ke Pusat Pengurusan Aplikasi Twitter; Buat aplikasi untuk merebut kekunci dan token akses anda.
Buat kelas PHP dan sertakan sifat -sifat yang akan menyimpan pelbagai parameter. Ini digariskan di bawah.
<span>class Twitter_API_WordPress { </span> <span>/** <span>@var <span>string</span> OAuth access token */</span> </span> <span>private $oauth_access_token; </span> <span>/** <span>@var <span>string</span> OAuth access token secrete */</span> </span> <span>private $oauth_access_token_secret; </span> <span>/** <span>@var <span>string</span> Consumer key */</span> </span> <span>private $consumer_key; </span> <span>/** <span>@var <span>string</span> consumer secret */</span> </span> <span>private $consumer_secret; </span> <span>/** <span>@var <span>array</span> POST parameters */</span> </span> <span>private $post_fields; </span> <span>/** <span>@var <span>string</span> GET parameters */</span> </span> <span>private $get_field; </span> <span>/** <span>@var <span>array</span> OAuth credentials */</span> </span> <span>private $oauth_details; </span> <span>/** <span>@var <span>string</span> Twitter's request URL */</span> </span> <span>private $request_url; </span> <span>/** <span>@var <span>string</span> Request method or HTTP verb */</span> </span> <span>private $request_method;</span>
Pembina akan menerima pelbagai kunci dan rahsia pengguna aplikasi Twitter (atau API) anda, serta akses token dan rahsia akses dan menyelamatkan mereka ke sifat masing -masing.
<span>/** Class constructor */ </span> <span>public function __construct( $settings ) { </span> <span>if ( ! isset( $settings['oauth_access_token'] ) </span> <span>|| ! isset( $settings['oauth_access_token_secret'] ) </span> <span>|| ! isset( $settings['consumer_key'] ) </span> <span>|| ! isset( $settings['consumer_secret'] ) </span> <span>) { </span> <span>return new WP_Error( 'twitter_param_incomplete', 'Make sure you are passing in the correct parameters' ); </span> <span>} </span> <span>$this->oauth_access_token = $settings['oauth_access_token']; </span> <span>$this->oauth_access_token_secret = $settings['oauth_access_token_secret']; </span> <span>$this->consumer_key = $settings['consumer_key']; </span> <span>$this->consumer_secret = $settings['consumer_secret']; </span> <span>}</span>seterusnya adalah kaedah yang akan menerima parameter Get atau Post untuk permintaan HTTP.
<span>/** </span><span> * Store the POST parameters </span><span> * </span><span> * <span>@param <span>array</span> $array array of POST parameters </span></span><span> * </span><span> * <span>@return $this </span></span><span> */ </span> <span>public function set_post_fields( array $array ) { </span> <span>$this->post_fields = $array; </span> <span>return $this; </span> <span>} </span> <span>/** </span><span> * Store the GET parameters </span><span> * </span><span> * <span>@param $string </span></span><span> * </span><span> * <span>@return $this </span></span><span> */ </span> <span>public function set_get_field( $string ) { </span> <span>$this->getfield = $string; </span> <span>return $this; </span> <span>}</span>kaedah peribadi _build_signature_base_string () menerima hujah -hujah berikut untuk membuat rentetan asas tandatangan: url permintaan, kaedah permintaan atau kata kerja http dan kelayakan oauth (kunci pengguna dan rahsia; akses token dan rahsia; dan parameter get jika ia adalah permintaan get).
<span>/** </span><span> * Create a signature base string from list of arguments </span><span> * </span><span> * <span>@param <span>string</span> $request_url request url or endpoint </span></span><span> * <span>@param <span>string</span> $method HTTP verb </span></span><span> * <span>@param <span>array</span> $oauth_params Twitter's OAuth parameters </span></span><span> * </span><span> * <span>@return <span>string</span> </span></span><span> */ </span> <span>private function _build_signature_base_string( $request_url, $method, $oauth_params ) { </span> <span>// save the parameters as key value pair bounded together with '&' </span> <span>$string_params = array(); </span> <span>ksort( $oauth_params ); </span> <span>foreach ( $oauth_params as $key => $value ) { </span> <span>// convert oauth parameters to key-value pair </span> <span>$string_params[] = "<span><span>$key</span>=<span>$value</span>"</span>; </span> <span>} </span> <span>return "<span><span>$method</span>&"</span> . rawurlencode( $request_url ) . '&' . rawurlencode( implode( '&', $string_params ) ); </span> <span>}</span>_generate_oauth_signature () kaedah peribadi menerima rentetan asas tandatangan yang dibuat untuk menghasilkan tandatangan oauth.
<span>private function _generate_oauth_signature( $data ) { </span> <span>// encode consumer and token secret keys and subsequently combine them using & to a query component </span> <span>$hash_hmac_key = rawurlencode( $this->consumer_secret ) . '&' . rawurlencode( $this->oauth_access_token_secret ); </span> <span>$oauth_signature = base64_encode( hash_hmac( 'sha1', $data, $hash_hmac_key, true ) ); </span> <span>return $oauth_signature; </span><span>}</span>BUILD_OAUTH () mencipta array yang mengandungi data berikut dan menyimpannya ke harta OAuth_Details, yang akan digunakan kemudian oleh Pihak Berkuasa_HEADER () untuk menghasilkan tajuk kebenaran.
<span>/** </span><span> * Build, generate and include the OAuth signature to the OAuth credentials </span><span> * </span><span> * <span>@param <span>string</span> $request_url Twitter endpoint to send the request to </span></span><span> * <span>@param <span>string</span> $request_method Request HTTP verb eg GET or POST </span></span><span> * </span><span> * <span>@return $this </span></span><span> */ </span> <span>public function build_oauth( $request_url, $request_method ) { </span> <span>if ( ! in_array( strtolower( $request_method ), array( 'post', 'get' ) ) ) { </span> <span>return new WP_Error( 'invalid_request', 'Request method must be either POST or GET' ); </span> <span>} </span> <span>$oauth_credentials = array( </span> <span>'oauth_consumer_key' => $this->consumer_key, </span> <span>'oauth_nonce' => time(), </span> <span>'oauth_signature_method' => 'HMAC-SHA1', </span> <span>'oauth_token' => $this->oauth_access_token, </span> <span>'oauth_timestamp' => time(), </span> <span>'oauth_version' => '1.0' </span> <span>); </span> <span>if ( ! is_null( $this->get_field ) ) { </span> <span>// remove question mark(?) from the query string </span> <span>$get_fields = str_replace( '?', '', explode( '&', $this->get_field ) ); </span> <span>foreach ( $get_fields as $field ) { </span> <span>// split and add the GET key-value pair to the post array. </span> <span>// GET query are always added to the signature base string </span> <span>$split = explode( '=', $field ); </span> <span>$oauth_credentials[ $split[0] ] = $split[1]; </span> <span>} </span> <span>} </span> <span>// convert the oauth credentials (including the GET QUERY if it is used) array to query string. </span> <span>$signature = $this->_build_signature_base_string( $request_url, $request_method, $oauth_credentials ); </span> <span>$oauth_credentials['oauth_signature'] = $this->_generate_oauth_signature( $signature ); </span> <span>// save the request url for use by WordPress HTTP API </span> <span>$this->request_url = $request_url; </span> <span>// save the OAuth Details </span> <span>$this->oauth_details = $oauth_credentials; </span> <span>$this->request_method = $request_method; </span> <span>return $this; </span> <span>}</span>di sini adalah kod untuk kaedah kuasa_header () yang kita bicarakan.
<span>/** </span><span> * Generate the authorization HTTP header </span><span> * <span>@return <span>string</span> </span></span><span> */ </span> <span>public function authorization_header() { </span> <span>$header = 'OAuth '; </span> <span>$oauth_params = array(); </span> <span>foreach ( $this->oauth_details as $key => $value ) { </span> <span>$oauth_params[] = "<span><span>$key</span>=\""</span> . rawurlencode( $value ) . '"'; </span> <span>} </span> <span>$header .= implode( ', ', $oauth_params ); </span> <span>return $header; </span> <span>}</span>process_request () akan menghantar permintaan get atau pos menggunakan wp_remote_get () atau wp_remote_post () bergantung pada kaedah permintaan dan seterusnya mengembalikan respons menggunakan wp_remote_retrieve_body ().
Lihat tutorial ini untuk pemahaman yang lebih baik mengenai API HTTP WordPress dan bagaimana ia berfungsi.
<span>/** </span><span> * Process and return the JSON result. </span><span> * </span><span> * <span>@return <span>string</span> </span></span><span> */ </span> <span>public function process_request() { </span> <span>$header = $this->authorization_header(); </span> <span>$args = array( </span> <span>'headers' => array( 'Authorization' => $header ), </span> <span>'timeout' => 45, </span> <span>'sslverify' => false </span> <span>); </span> <span>if ( ! is_null( $this->post_fields ) ) { </span> <span>$args['body'] = $this->post_fields; </span> <span>$response = wp_remote_post( $this->request_url, $args ); </span> <span>return wp_remote_retrieve_body( $response ); </span> <span>} </span> <span>else { </span> <span>// add the GET parameter to the Twitter request url or endpoint </span> <span>$url = $this->request_url . $this->get_field; </span> <span>$response = wp_remote_get( $url, $args ); </span> <span>return wp_remote_retrieve_body( $response ); </span> <span>} </span> <span>}</span>
Dan akhirnya, kami menutup kelas.
Sila ambil perhatian: di set_post_fields (), set_get_field () dan build_oauth (), objek $ ini dikembalikan dalam setiap kaedah untuk menyokong kaedah chaining.
<span>} // Twitter_API_WordPress</span>Contoh:
lihat penggunaan kelas di bawah untuk pemahaman yang lebih baik.
<span>$SomeObject->getObjectOne()->getObjectTwo()</span>cara menggunakan kelas
Kelas ini mesti digunakan dalam konteks plugin WordPress. Ia tidak akan berfungsi sebagai kelas mandiri kerana ia memerlukan API WordPress HTTP untuk berfungsi.
Pertama, buat pelbagai kunci dan token akses anda.
<span>class Twitter_API_WordPress { </span> <span>/** <span>@var <span>string</span> OAuth access token */</span> </span> <span>private $oauth_access_token; </span> <span>/** <span>@var <span>string</span> OAuth access token secrete */</span> </span> <span>private $oauth_access_token_secret; </span> <span>/** <span>@var <span>string</span> Consumer key */</span> </span> <span>private $consumer_key; </span> <span>/** <span>@var <span>string</span> consumer secret */</span> </span> <span>private $consumer_secret; </span> <span>/** <span>@var <span>array</span> POST parameters */</span> </span> <span>private $post_fields; </span> <span>/** <span>@var <span>string</span> GET parameters */</span> </span> <span>private $get_field; </span> <span>/** <span>@var <span>array</span> OAuth credentials */</span> </span> <span>private $oauth_details; </span> <span>/** <span>@var <span>string</span> Twitter's request URL */</span> </span> <span>private $request_url; </span> <span>/** <span>@var <span>string</span> Request method or HTTP verb */</span> </span> <span>private $request_method;</span>
Tetapkan url permintaan dan kaedah di mana w3guy adalah nama pengguna Twitter anda.
<span>/** Class constructor */ </span> <span>public function __construct( $settings ) { </span> <span>if ( ! isset( $settings['oauth_access_token'] ) </span> <span>|| ! isset( $settings['oauth_access_token_secret'] ) </span> <span>|| ! isset( $settings['consumer_key'] ) </span> <span>|| ! isset( $settings['consumer_secret'] ) </span> <span>) { </span> <span>return new WP_Error( 'twitter_param_incomplete', 'Make sure you are passing in the correct parameters' ); </span> <span>} </span> <span>$this->oauth_access_token = $settings['oauth_access_token']; </span> <span>$this->oauth_access_token_secret = $settings['oauth_access_token_secret']; </span> <span>$this->consumer_key = $settings['consumer_key']; </span> <span>$this->consumer_secret = $settings['consumer_secret']; </span> <span>}</span>
Akhirnya, proses permintaan seperti itu.
<span>/** </span><span> * Store the POST parameters </span><span> * </span><span> * <span>@param <span>array</span> $array array of POST parameters </span></span><span> * </span><span> * <span>@return $this </span></span><span> */ </span> <span>public function set_post_fields( array $array ) { </span> <span>$this->post_fields = $array; </span> <span>return $this; </span> <span>} </span> <span>/** </span><span> * Store the GET parameters </span><span> * </span><span> * <span>@param $string </span></span><span> * </span><span> * <span>@return $this </span></span><span> */ </span> <span>public function set_get_field( $string ) { </span> <span>$this->getfield = $string; </span> <span>return $this; </span> <span>}</span>
Jika semuanya berjalan lancar, hasil pembolehubah $ akan dihuni dengan data JSON dari tweet baru -baru ini.
Untuk permintaan pos, contohnya, katakan anda ingin mengemas kini penerangan profil anda.
<span>/** </span><span> * Create a signature base string from list of arguments </span><span> * </span><span> * <span>@param <span>string</span> $request_url request url or endpoint </span></span><span> * <span>@param <span>string</span> $method HTTP verb </span></span><span> * <span>@param <span>array</span> $oauth_params Twitter's OAuth parameters </span></span><span> * </span><span> * <span>@return <span>string</span> </span></span><span> */ </span> <span>private function _build_signature_base_string( $request_url, $method, $oauth_params ) { </span> <span>// save the parameters as key value pair bounded together with '&' </span> <span>$string_params = array(); </span> <span>ksort( $oauth_params ); </span> <span>foreach ( $oauth_params as $key => $value ) { </span> <span>// convert oauth parameters to key-value pair </span> <span>$string_params[] = "<span><span>$key</span>=<span>$value</span>"</span>; </span> <span>} </span> <span>return "<span><span>$method</span>&"</span> . rawurlencode( $request_url ) . '&' . rawurlencode( implode( '&', $string_params ) ); </span> <span>}</span>
Struktur dan kod kelas ini diilhamkan oleh pelanggan Twitter PHP James Mallison.
Untuk mengetahui lebih lanjut mengenai Twitter API dan OAuth, lihat sumber di bawah.
Dalam artikel ini, kami belajar tentang OAuth dan bagaimana untuk menggunakan Twitter menggunakan kelas klien HTTP yang dikuasakan oleh WordPress HTTP API. Seperti yang dinyatakan sebelum ini, kelas ini harus digunakan dalam plugin WordPress kerana ia menggunakan API WordPress HTTP, yang hanya hadir atau instantiated apabila WordPress dimuatkan. Kelas PHP ini boleh menjadi berguna dalam bangunan, sebagai contoh, widget tweet baru -baru ini.
Kod ini boleh didapati di GitHub. Jangan ragu untuk mengemukakan permintaan tarik.
Pastikan untuk melanggan saluran WordPress untuk mengikuti tutorial saya yang akan datang.
soalan yang sering ditanya mengenai OAuth, Twitter, dan WordPress HTTP APIPlugin Server Miniorange OAuth 2.0 untuk WordPress menyediakan cara yang mudah dan selamat untuk menyediakan pelayan OAuth2.0 pada laman WordPress anda. Ia menyokong pelbagai jenis geran, termasuk kod kebenaran, tersirat, kata laluan, dan kelayakan pelanggan, dan ia juga menyokong JWT dan SAML. Ini menjadikannya pilihan yang fleksibel dan kuat untuk melaksanakan OAuth2.0 di laman WordPress anda.
Atas ialah kandungan terperinci OAuth, Twitter, WordPress HTTP API dan anda. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!