ogulcan

<p>If you ever used WP Rest API, you should have noticed that there are lots of fields that even your client does not need. It makes no sense to load all fields for simple list or even single post view.</p>
<p>This plugin aims to remove redundant fields on Rest API. For now, it’s only available for posts.</p>
<h4>Features</h4>
<p>There are two endpoints: “compact” and “detailed.</p>
<ul>
<li>“Compact” is useful for listing posts and Detailed is better for single post view.</li>
<li>First image of featured media will be added as ‘image’ on detailed and compact.</li>
<li>Modified was used as default date.</li>
<li>Requires at least WordPress 4.7</li>
</ul>


Filter WP Api

A wordpress plugin that clears huge fields of WP Rest API.

Gaurav Sharma

<p>Extends the WP REST API using JSON Web Tokens as an authentication method.<br />
GS JWT plugin provides to encode and decode JSON Web Tokens (JWT), conforming to RFC 7519.</p>
<p>GET OTP and send notification by mail or SMS service</p>
<p><strong>Support and Requests please in Github:</strong> https://github.com/gauravin213/gs-jwt</p>
<h3>REQUIREMENTS</h3>
<h3>PHP</h3>
<p><strong>Minimum PHP version: 5.3.0</strong></p>
<h3>PHP HTTP Authorization Header enable</h3>
<p>Most of the shared hosting has disabled the <strong>HTTP Authorization Header</strong> by default.</p>
<p>To enable this option you’ll need to edit your <strong>.htaccess</strong> file adding the following</p>
<pre><code>RewriteEngine on
RewriteCond %{HTTP:Authorization} ^(.*)
RewriteRule ^(.*) - [E=HTTP_AUTHORIZATION:%1]
</code></pre>
<h4>WPENGINE</h4>
<p>To enable this option you’ll need to edit your <strong>.htaccess</strong> file adding the following</p>
<pre><code>SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1
</code></pre>
<h4>CONFIGURATION</h4>
<p>The JWT needs to Add constant in the wp-confige.php file</p>
<pre><code>define( 'GS_WP_JWT_SECRET_KEY', 'your-top-secret-key' );
define( 'GS_WP_JWT_ALGO', 'HS256' );
define( 'GS_WP_JWT_EXPIRY', (60 * 60) ); //seconds * minuts
define( 'GS_WP_OTP_EXPIRY', 10);  //minuts
</code></pre>
<h3>Namespace and Endpoints</h3>
<p>When the plugin is activated, a new namespace is added</p>
<pre><code>/gs-jwt/v1
</code></pre>
<p>Also, two new endpoints are added to this namespace</p>
<p>Endpoint | HTTP Verb</p>
<p><em>/wp-json/gs-jwt/v1/login</em> | POST</p>
<p><em>/wp-json/gs-jwt/v1/token/validate</em> | POST</p>
<p><em>/wp-json/gs-jwt/v1/get-otp</em> | POST</p>
<p><em>/wp-json/gs-jwt/v1/verify-otp</em> | POST</p>
<p><em>/wp-json/gs-jwt/v1/register_user</em> | POST</p>
<p><em>/wp-json/gs-jwt/v1/register_userbymobile</em> | POST</p>
<h3>USAGE</h3>
<ol>
<li>Get JSON web token</li>
</ol>
<h4>Request method:</h4>
<pre><code>POST /wp-json/gs-jwt/v1/login

Body{
    "username": "enter username",
    "password": "enter password"
}
</code></pre>
<h4>Reponse</h4>
<pre><code>{
    "data": {
        "id": "1",
        "user_login": "admin",
        "user_pass": null,
        "user_nicename": "admin",
        "user_email": "example@gmail.com",
        "user_url": "",
        "user_registered": "2020-08-11 07:35:37",
        "user_activation_key": "",
        "user_status": "0",
        "display_name": "admin",
        "roles": [
            "administrator"
        ],
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC8xMjcuMC4wLjFcL3dvcmRwcmVzcyIsImlhdCI6MTY0MTk3MDIwNSwibmJmIjoxNjQxOTcwMjA1LCJleHAiOjE2NDE5NzM4MDUsImRhdGEiOnsidXNlciI6eyJpZCI6IjEifX19.gRF_aNsmhQ8kqXYdKbm6dIA7zTlhcCU-e_cpP9pQDyM"
    }
}
</code></pre>
<ol>
<li>Validate JSON web token</li>
</ol>
<h4>Request method:</h4>
<pre><code>POST /wp-json/gs-jwt/v1/token/validate

Make a POST request sending the Authorization header
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC8xMjcuMC4wLjFcL3dvcmRwcmVzcyIsImlhdCI6MTY0MTk3MDIwNSwibmJmIjoxNjQxOTcwMjA1LCJleHAiOjE2NDE5NzM4MDUsImRhdGEiOnsidXNlciI6eyJpZCI6IjEifX19.gRF_aNsmhQ8kqXYdKbm6dIA7zTlhcCU-e_cpP9pQDyM
</code></pre>
<h4>Reponse</h4>
<pre><code>{
    "code": "jwt_auth_valid_token",
    "data": {
        "status": 200
    }
}
</code></pre>
<ol>
<li>Get otp by billing mobile number</li>
</ol>
<h4>Request method:</h4>
<pre><code>POST /wp-json/gs-jwt/v1/get-otp

Body{
    "mobile": "enter mobile number"
}
</code></pre>
<h4>Reponse</h4>
<pre><code>{
    "data": {
        "otp": 249225,
        "message": "SUCCESS",
        "otp_use_staus": "0",
        "notification": {
            "mail_send_status": 0,
            "sms_send_status": 0
        }
    }
}
</code></pre>
<ol>
<li>Verify otp and mobile number to login </li>
</ol>
<h4>Request method:</h4>
<pre><code>POST /wp-json/gs-jwt/v1/verify-otp

Body{
    "otp": "enter otp",
    "mobile": "enter mobile number"
}
</code></pre>
<h4>Reponse</h4>
<pre><code>{
    "data": {
        "id": "1",
        "user_login": "admin",
        "user_pass": null,
        "user_nicename": "admin",
        "user_email": "example@gmail.com",
        "user_url": "",
        "user_registered": "2020-08-11 07:35:37",
        "user_activation_key": "",
        "user_status": "0",
        "display_name": "admin",
        "roles": [
            "administrator"
        ],
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC8xMjcuMC4wLjFcL3dvcmRwcmVzcyIsImlhdCI6MTY0MTk3MDIwNSwibmJmIjoxNjQxOTcwMjA1LCJleHAiOjE2NDE5NzM4MDUsImRhdGEiOnsidXNlciI6eyJpZCI6IjEifX19.gRF_aNsmhQ8kqXYdKbm6dIA7zTlhcCU-e_cpP9pQDyM"
    }
}
</code></pre>
<ol>
<li>Register user</li>
</ol>
<h4>Request method:</h4>
<pre><code>POST /wp-json/gs-jwt/v1/register_user

Body{
    "username": "example",
    "password": "example@123",
    "email": "example@gmail.com",
    "mobile": "1122336699"
}
</code></pre>
<h4>Reponse</h4>
<pre><code>{
    "data": {
        "id": 29,
        "user_login": "example",
        "user_pass": null,
        "user_nicename": "example",
        "user_email": "example@gmail.com",
        "user_url": "",
        "user_registered": "2022-01-12 07:45:29",
        "user_activation_key": "",
        "user_status": "0",
        "display_name": "example",
        "roles": [
            "customer"
        ],
        "billing_phone": "1122336699"
    },
    "code": 200,
    "message": "Registration was Successful"
}
</code></pre>
<ol>
<li>Register user by mobile number</li>
</ol>
<h4>Request method:</h4>
<pre><code>POST /wp-json/gs-jwt/v1/register_userbymobile

Body{
    "mobile": "1122336699"
}
</code></pre>
<h4>Reponse</h4>
<pre><code>{
    "data": {
        "id": 32,
        "user_login": "1144556638",
        "user_nicename": "1144556638",
        "user_registered": "2022-01-13 06:29:30",
        "display_name": "1144556638",
        "roles": [
            "customer"
        ],
        "billing_phone": "1144556638"
    },
    "code": 200,
    "message": "Registration was Successful"
}
</code></pre>
<h4>Sample add SMS and email notification</h4>
<pre><code>/*
* Send notification 
* Default mail_send_status = 0, sms_send_status = 0
*/
function gs_wp_jwt_send_notification_fun( $data, $user_id, $otp, $mobile ) {

  //Write mail send code here
  $from = get_option('admin_email');
  $to = get_user_meta($user_id, 'billing_email', true);
  $subject = "OTP Verification";
  $message = "OTP number: {$opt} will expire in 10 min";
  $headers = "From: ".$from;
  $result = wp_mail( $to, $subject, $message, $headers);

  if ($result) { 

    $data['mail_send_status'] = 1;

  } //end mail send


  //Write sms send api code here
  /*if ($sms_send_status) { 

    $data['sms_send_status'] = 1;

  } //ens sms send*/

  return $data;
}
add_filter( 'gs_wp_jwt_send_notification', 'gs_wp_jwt_send_notification_fun', 10, 4 );
</code></pre>


GS JWT Authentication for WP REST API

Extends the WP REST API using JSON Web Tokens as an authentication method.

Filter WP Api vs GS JWT Authentication for WP REST API