WP REST API Key Authentication

外掛說明

WP REST API Key Authentication adds a simple API key-based authentication method to the WordPress REST API. This plugin is perfect for developers who want to interact with the REST API securely without relying on complex OAuth authentication mechanisms.

Key Features:

  • Multiple API Keys: Create and manage multiple API keys with custom names.
  • Secure API Key Storage: API keys are hashed and securely stored in the WordPress database.
  • Single Display for Security: API keys are shown only once after creation.
  • REST API Access Control: Authenticate requests by including an API key in the Authorization header.
  • Admin Interface: Manage API keys with a user-friendly admin page.
  • Copy to Clipboard Popup: Easily copy generated API keys with a built-in popup.

The plugin is lightweight and integrates seamlessly with WordPress.

Usage

  1. Generate an API Key:

    • Go to API Keys in the WordPress admin menu.
    • Enter a name for the API key and click “Generate API Key”.
    • The API key will appear in a popup. Copy it immediately, as it will not be displayed again.
  2. Use the API Key:

    • Include the API key in the Authorization header of your REST API requests:
      Authorization: Bearer YOUR_API_KEY
  3. Delete API Keys:

    • To revoke access, delete an API key from the API Keys admin page.

License

This plugin is licensed under the GPLv2 or later. See the License URI for details.

螢幕擷圖

  • API Key Management Interface
    Manage API keys with a simple interface, including options to create and delete keys.

  • Generated API Key Popup
    Popup showing the API key after generation, with an option to copy it to the clipboard.

  • REST API Authorization Example
    Example of how to use the API key in the Authorization header.

安裝方式

  1. Download the plugin ZIP file.
  2. Go to your WordPress admin dashboard and navigate to Plugins > Add New.
  3. Click on the Upload Plugin button and select the ZIP file.
  4. Click Install Now and then activate the plugin.
  5. Navigate to API Keys in the admin menu to start managing your API keys.

常見問題集

How are API keys stored?

API keys are hashed using PHP’s password_hash function and stored securely in the WordPress database. The raw key is only shown once upon creation.

What happens if I lose an API key?

If you lose an API key, you must generate a new one. The plugin does not store raw API keys for security reasons.

How do I authenticate a REST API request?

Include the API key in the Authorization header using the Bearer token format: Authorization: Bearer YOUR_API_KEY

Can I create multiple API keys?

Yes, you can generate multiple API keys with custom names and manage them from the admin interface.

使用者評論

這個外掛目前沒有任何使用者評論。

參與者及開發者

以下人員參與了開源軟體〈WP REST API Key Authentication〉的開發相關工作。

參與者

〈WP REST API Key Authentication〉外掛目前已有 1 個本地化語言版本。 感謝全部譯者為這個外掛做出的貢獻。

將〈WP REST API Key Authentication〉外掛本地化為台灣繁體中文版

對開發相關資訊感興趣?

任何人均可瀏覽程式碼、查看 SVN 存放庫,或透過 RSS 訂閱開發記錄

變更記錄

1.0

  • Initial release.
  • Added support for API key creation and deletion.
  • Added REST API authentication using API keys.
  • Added popup with “Copy to Clipboard” functionality for generated API keys.