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%
Kumibox-info
Kumibox-info is a specialized tool for local news portals. It connects your WordPress site to the Kumibox-info API to automatically import news, alerts, and data relevant to your region (Police, Fire Department, Culture, Sports, Weather, Statistics, and more). This plugin provides a seamless dashboard for managing data sources, monitoring usage limits, and handling subscriptions. Key Features: Automated News Importing: Fetches news articles and creates WordPress posts automatically (Draft or Publish status). Smart Widgets: Display live data like Weather, NFZ (National Health Fund) queues, Tenders, and Statistics using simple Shortcodes (e.g., [kumiboxinfo_data id=”123″]). Client Dashboard: Manage your subscription, view usage stats, and configure data sources directly from the WP Admin. Categorization: Intelligent mapping of external categories (e.g., Police, Culture) to your system. Security: Built with WordPress nonces and capability checks to ensure secure data handling. Important: 3rd Party Service Disclaimer This plugin acts as a connector (client) for an external service. It sends requests to 3rd party APIs to function properly. Kumiboxinfo API (Main Service) This plugin connects to the Kumiboxinfo API servers (hosted at kumibox.net) to fetch news content, weather data, and configuration settings. To use this plugin, you must have an API Key. You can register for a Free account directly within the plugin interface. The plugin facilitates subscription payments for premium plans via Paddle. All payments are processed securely on Paddle’s servers; no credit card data is stored on your WordPress site. External services This plugin connects to the Kumiboxinfo API (hosted at https://paletyzer.kumibox.net/api5/) to fetch news content, weather data, and widget configurations. What data is sent: The plugin sends the saved API Key for authentication and the user’s email address when creating a new account or recovering a key. For weather and specific widgets, it may send latitude, longitude, or city names based on the user’s plugin configuration. When data is sent: Data is sent automatically in the background via WordPress Cron (hourly or according to the user’s plan), or manually when the user clicks “Refresh” or saves settings in the admin panel. Kumibox Terms of Service: https://kumibox.net/en/terms-of-service/ Kumibox Privacy Policy: https://kumibox.net/en/privacy/ This plugin also integrates with Paddle (https://paddle.com) to handle secure payments and subscription management. What data is sent: The user’s email address and API key are passed as URL parameters when opening the Paddle checkout link to pre-fill the form and link the subscription to the correct account. When data is sent: Only when the user manually clicks the “Buy” or “Choose Plan” buttons in the admin panel. Paddle Terms of Use: https://www.paddle.com/legal/terms Paddle Privacy Policy: https://www.paddle.com/legal/privacy 3rd Party Resources This plugin bundles the following third-party resources: Bootstrap (v5.3.0) Source: https://getbootstrap.com License: MIT Copyright 2011-2023 The Bootstrap Authors Bootstrap Icons (v1.10.0) Source: https://icons.getbootstrap.com License: MIT Copyright 2019-2023 The Bootstrap Authors