diff --git a/docs/api_keys.png b/docs/api_keys.png new file mode 100644 index 00000000..9218d677 Binary files /dev/null and b/docs/api_keys.png differ diff --git a/docs/create_api_key.png b/docs/create_api_key.png new file mode 100644 index 00000000..46ec06a5 Binary files /dev/null and b/docs/create_api_key.png differ diff --git a/wiki.md b/wiki.md index 4751f884..c1370570 100644 --- a/wiki.md +++ b/wiki.md @@ -53,6 +53,8 @@ We highly recommend gathering all the below information before starting the inst - AltaPay credentials for the payment gateway, terminals and custom gateway (i.e. yourShopName.altapaysecure.com). These will be provided by AltaPay. +> **Note:** If the API user credentials have not yet been created, refer to the [Creating a New API User](#creating-a-new-api-user) section for step-by-step instructions. + ## Installation @@ -271,6 +273,27 @@ In order to reconcile payments please follow the steps below: > > If you customized the plugin source code, the changes may be overwritten in the update process. +## Creating a New API User + +To create a new API user in your AltaPay account, please follow these steps: + +- Log in to your AltaPay account. +- From the left menu, navigate to **Settings** > **API Keys**. + + ![api_key](docs/api_keys.png) + +- Click on the **Create New API Key** button from top right corner. +- Fill in the required fields: + - **Your current password** + - **Username** + - **Password** + - **Assign Shops** + + ![api_key](docs/create_api_key.png) +- After entering the details, click **Create**. + +The new credentials can now be used as the API Username and API Password in your AltaPay settings. + ## Supported versions Minimum system requirements are: