Title: API Bearer Auth
Author: michielve
Published: 2017 年 12 月 1 日
Last modified: 2025 年 12 月 8 日
---
搜尋外掛
# API Bearer Auth
由 [michielve](https://profiles.wordpress.org/michielve/) 開發
[下載](https://downloads.wordpress.org/plugin/api-bearer-auth.zip)
* [詳細資料](https://tw.wordpress.org/plugins/api-bearer-auth/#description)
* [使用者評論](https://tw.wordpress.org/plugins/api-bearer-auth/#reviews)
* [安裝方式](https://tw.wordpress.org/plugins/api-bearer-auth/#installation)
* [開發資訊](https://tw.wordpress.org/plugins/api-bearer-auth/#developers)
[技術支援](https://wordpress.org/support/plugin/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/](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!
## 安裝方式
1. Upload the plugin files to the `/wp-content/plugins/api-bearer-auth` directory,
or install the plugin through the WordPress plugins screen directly.
2. If you want your access tokens to be formatted as JWT tokens, define a random string
as a `API_BEARER_JWT_SECRET` define in your wp-config.php file.
3. Activate the plugin through the ‘Plugins’ screen in WordPress.
4. From now on, every REST API endpoint needs to be authenticated.
## 常見問題集
### Change time the access tokens are valid
By default an access token is valid for 1 day. You can change this, by defining
the `API_BEARER_ACCESS_TOKEN_VALID_IN_SECONDS` constant in your wp-config.php file.
```
define('API_BEARER_ACCESS_TOKEN_VALID_IN_SECONDS', 3600); // 1 hour
```
### Whitelist unauthenticated URLs
By default all REST API endpoints are only available for authenticated users. If
you want to add some more endpoints to this whitelist, you can use the `api_bearer_auth_unauthenticated_urls`
filter. Note that you need to specify the endpoint relative to the `site_url()`
and that you can specify regular expressions.
For example:
```
add_filter('api_bearer_auth_unauthenticated_urls', 'api_bearer_auth_unauthenticated_urls_filter', 10, 2);
function api_bearer_auth_unauthenticated_urls_filter($custom_urls, $request_method) {
switch ($request_method) {
case 'POST':
$custom_urls[] = '/wp-json/myplugin/v1/something/?';
break;
case 'GET':
$custom_urls[] = '/wp-json/myplugin/v1/something/other/?';
break;
}
return $custom_urls;
}
```
## 使用者評論
### [Good work](https://wordpress.org/support/topic/good-work-714/)
[Andrey](https://profiles.wordpress.org/guitmann/) 2021 年 8 月 27 日
Thanx
### [Great plugin](https://wordpress.org/support/topic/great-plugin-30521/)
[rrr3da](https://profiles.wordpress.org/rrr3da/) 2021 年 4 月 12 日
We choose this plugin wrt the more popular alternatives to make use of the refresh
token endpoint. Easy to setup, work as expected.. flawlessly! Wordpress version:
5.7, PHP 7.4 Thank you
### [Simply Amazing plugin](https://wordpress.org/support/topic/bl/)
[akaydavid](https://profiles.wordpress.org/akaydavid/) 2020 年 7 月 6 日
Thanks for this plugin & for enhancing wordpress with more long-awaited developer
tools. God bless you real good.
### [Simple](https://wordpress.org/support/topic/simple-454/)
[Son Do](https://profiles.wordpress.org/sondoha/) 2020 年 5 月 27 日
I love how simple the plugin is. Just need to install, read docs and follow in 5
mins. Thank you!
### [Excellent plugin](https://wordpress.org/support/topic/excellent-plugin-5728/)
[EvdHeuvel](https://profiles.wordpress.org/evdheuvel/) 2020 年 4 月 13 日
Nice and simple!
### [Perfectly simple](https://wordpress.org/support/topic/perfectly-simple-25/)
[Sotiris Katsaniotis](https://profiles.wordpress.org/sotiris_k/) 2020 年 2 月 25
日
The plugin is refreshingly simple in its purpose and it does it perfectly. I could
use it to login and use my API via JWT Auth in seconds! Thanks!
[ 閱讀全部 6 則使用者評論 ](https://wordpress.org/support/plugin/api-bearer-auth/reviews/)
## 參與者及開發者
以下人員參與了開源軟體〈API Bearer Auth〉的開發相關工作。
參與者
* [ michielve ](https://profiles.wordpress.org/michielve/)
[將〈API Bearer Auth〉外掛本地化為台灣繁體中文版](https://translate.wordpress.org/projects/wp-plugins/api-bearer-auth)
### 對開發相關資訊感興趣？
任何人均可[瀏覽程式碼](https://plugins.trac.wordpress.org/browser/api-bearer-auth/)、
查看 [SVN 存放庫](https://plugins.svn.wordpress.org/api-bearer-auth/)，或透過 [RSS](https://plugins.trac.wordpress.org/log/api-bearer-auth/?limit=100&mode=stop_on_copy&format=rss)
訂閱[開發記錄](https://plugins.trac.wordpress.org/log/api-bearer-auth/)。
## 變更記錄
#### 20200916
* Added permission_callback to prevent error in log.
#### 20200911
* Added client_name key to login and refresh endpoint.
* Database changes: client_name and some indexes.
#### 20200902
* Fix for servers that change the headers to lower or uppercase.
#### 20200818
* Removed `user_pass` from returned user after login call.
#### 20200807
* Big bug fixed (thanks to @harchvertelol!), please update immediately! Calling
the refresh request will update ALL access tokens! This is now fixed.
#### 20200717
* Preflight requests (OPTIONS) should not require autentication:
#### 20190908
* Removed Swagger
#### 20190907
* Sanitize user input for swagger file
#### 20181229
* Revoke tokens from the users admin screen
* Better documentation
#### 20181228
* Migrations
* Refresh token is not a JWT token
#### 20181226
* Also returns expires_in for access token
* The use with a verified access JWT token is returned directly now without
querying
the database first.
* Changed the define for valid time access token
#### 20181225
* Added JWT tokens
#### 20181223
* Tested with WordPress 5.0.2
* Added Swagger to make testing of the plugin easier
#### 20171208
* Define constants to change valid period of access and refresh tokens
#### 20171130
* First release
## 中繼資料
* 版本 **20200916**
* 最後更新 **6 個月前**
* 啟用安裝數 **300+**
* WordPress 版本需求 ** 4.6 或更新版本 **
* 已測試相容的 WordPress 版本 **6.9.4**
* PHP 版本需求 ** 5.4.0 或更新版本 **
* 語言
* [English (US)](https://wordpress.org/plugins/api-bearer-auth/)
* 標籤:
* [api](https://tw.wordpress.org/plugins/tags/api/)[authentication](https://tw.wordpress.org/plugins/tags/authentication/)
[jwt](https://tw.wordpress.org/plugins/tags/jwt/)[rest-api](https://tw.wordpress.org/plugins/tags/rest-api/)
* [進階檢視](https://tw.wordpress.org/plugins/api-bearer-auth/advanced/)
## 評分
5 星，滿分為 5 星
* [ 6 個 5 星使用者評論 ](https://wordpress.org/support/plugin/api-bearer-auth/reviews/?filter=5)
* [ 0 個 4 星使用者評論 ](https://wordpress.org/support/plugin/api-bearer-auth/reviews/?filter=4)
* [ 0 個 3 星使用者評論 ](https://wordpress.org/support/plugin/api-bearer-auth/reviews/?filter=3)
* [ 0 個 2 星使用者評論 ](https://wordpress.org/support/plugin/api-bearer-auth/reviews/?filter=2)
* [ 0 個 1 星使用者評論 ](https://wordpress.org/support/plugin/api-bearer-auth/reviews/?filter=1)
[Your review](https://wordpress.org/support/plugin/api-bearer-auth/reviews/#new-post)
[查看全部使用者評論](https://wordpress.org/support/plugin/api-bearer-auth/reviews/)
## 參與者
* [ michielve ](https://profiles.wordpress.org/michielve/)
## 技術支援
使用者可在技術支援論壇提出意見反應或使用問題。
[檢視技術支援論壇](https://wordpress.org/support/plugin/api-bearer-auth/)