API Bearer Auth
The API Bearer Auth plugin enables authentication for the REST API by using JWT access an refresh tokens. After the user logs in, the access and refresh tokens are returned and can be used for the next requests. Issued tokens can be revoked from within the users admin screen. See below for the endpoints. Note that after activating this plugin, all REST API endpoints will need to be authenticated, unless the endpoint is whitelisted in the api_bearer_auth_unauthenticated_urls filter (see FAQ for how to use this filter). JWT Access tokens can be formatted as JWT tokens. For this to work, you first have to create a secret and add it to the wp-config.php file. If you don’t do this, access tokens will work also, but are just random strings. To create a random secret key, you can do for example: base64_encode(openssl_random_pseudo_bytes(64)); And then add the result to wp-config: define('API_BEARER_JWT_SECRET', 'mysecretkey'); If you have problems, you can verify your JWT tokens at: https://jwt.io/ Revoke tokens This plugin adds a column to the users table in de admin where you can see when a token expires. You can also revoke tokens by selection the “Revoke API tokens” from the bulk actions select box. API endpoints Note that all endpoints expect JSON in the POST body. Login Endpoint: POST /api-bearer-auth/v1/login Request body: Note: client_name is optional. But if you use it, make sure to use it as well for the refresh call! {"username": "my_username", "password": "my_password", "client_name": "my_app"} Response: { "wp_user": { "data": { "ID": 1, "user_login": "your_user_login", // other default WordPress user fields } }, "access_token": "your_access_token", "expires_in": 86400, // number of seconds "refresh_token": "your_refresh_token" } Make sure to save the access and refresh token! Refresh access token Endpoint: POST /api-bearer-auth/v1/tokens/refresh Request body: Note: client_name is optional. But if you did use it for the login call, make sure to use it here as well! {"token": "your_refresh_token", "client_name": "my_app"} Response success: { "access_token": "your_new_access_token", "expires_in": 86400 } Response when sending a wrong refresh token is a 401: { "code": "api_api_bearer_auth_error_invalid_token", "message": "Invalid token.", "data": { "status": 401 } } Do a request After you have the access token, you can make requests to authenticated endpoints with an Authorization header like this: Authorization: Bearer Note that Apache sometimes strips out the Authorization header. If this is the case, make sure to add this to the .htaccess file: RewriteCond %{HTTP:Authorization} ^(.*) # Don't know why, but some need the line below instead of the RewriteRule line # SetEnvIf Authorization .+ HTTP_AUTHORIZATION=$0 RewriteRule ^(.*) - [E=HTTP_AUTHORIZATION:%1] If you are not logged in or you send an invalid access token, you get a 401 response: { "code": "api_bearer_auth_not_logged_in", "message": "You are not logged in.", "data": { "status": 401 } } Important update Update immediately if you’re using a version below 20200807. Before this version all access tokens were updated when calling the refresh callback. If you are affected by this the fastest solution is to execute this query: update wp_user_tokens set access_token_valid = NOW(); This will invalidate all access tokens. This means that all users need to refresh their access token and will get a new access token and a unique one this time. A big thank to @harchvertelol for reporting this and suggesting the fix as well!
Top keywords
- token19×3.23%
- access17×2.89%
- tokens14×2.38%
- refresh12×2.04%
- access token10×1.70%
- api9×1.53%
- authorization7×1.19%
- bearer6×1.02%
- jwt6×1.02%
- user6×1.02%
- endpoints5×0.85%
- login5×0.85%
Get Use APIs – JSON Content Importer
The simplest method to link WordPress with external APIs JCI simplifies the task of retrieving data from a third-party REST API. The returned JSON-, XML, CSV, TXT-data can be neatly arranged and showcased on your WordPress site via a shortcode, a JCI Block or PHP. The plugin can generate a template for the data display. 20 seconds: Load API and display data 7 minutes: Basic intro to JCI free Examples, Preview Check out the live demonstration to explore how we’re interfacing with various APIs LIVE PREVIEW – WordPress and a external API Video: How to use the Wikipedia API Main Plugin Features Low code usage: Save time and avoid coding using an API Insert an API-URL into Step 1: Data is loaded, and and displayed. Save it as API-Access-Set. Use the API-Access-Set in Step 2 to create a Shortcode Optional for maximum flexibility: Use the API-Access-Set n PHP code Insert an API-URL into the JCI Block: Data is loaded, and a template can be generated to display the data. Easy to start: Check Installation – Is your WordPress ready for JCI? Most probably! Basic Settings: Check SSL, Cacher, Gutenberg and Authentication ContactForm7 Integration: Populate CF7 forms with JSON data and forward CF7-submitted data to an API. Use the JCI cacher to avoid many API requests JCI-Block : Use the simple JCI Block interface to get data! Query the API and check the response. Then utilize the simple template generator inside the JCI Block to use the data! Contact Form 7 Integration: Fill form and submit to API Important Note Starting with Version 2.0.11 Starting with version 2.0.11, any HTML code present in the shortcode or block is filtered to prevent dangerous code (e.g. JavaScript) from being output. However, if you want to allow certain tags or attributes as a deliberate choice: In the plugin’s “Basic Settings” there is a field called “Allow additional HTML tags (advanced)”. There you can enter comma-separated tags that should not be filtered out. For example, “iframe,script” would preserve these two tags in the HTML output. “tr#onclick” would preserve the “onclick” attribute in ”, which would otherwise be removed. Documentation There’s a wealth of resources and support at your fingertips. Explore the articles listed below to begin your journey: JCI Manual Step 1: Access the Data Step 2: Using the Data Shortcode – Basic structure Contact Form 7 Integration Free JCI Plugin: Overview Videos Free JCI Plugin: Getting Started You need more? JSON Content Importer PRO Both the free and PRO JCI Plugins serve the same purpose: retrieving data, transforming it, and publishing the results. However, while the free Plugin can only handle basic challenges, the PRO JCI Plugin offers nearly full control over WordPress, the database, and applications. Compare: Free vs. JCI PRO Plugin PRO features: * application building by creating a searchform and connect it to a JSON-API in the background: pass GET-Variables to use a dynamic JSON-Feed-URL (“talk to API / webservice”) * much better and more flexible templateengine: twig * create and use Custom Post Types * store Templates independent of pages * more Shortcode-Parameters * executing Shortcodes inside a template * more features…