diff --git a/docs/getting-started.md b/docs/getting-started.md index e418e2e..225751d 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,24 +1,52 @@ # Getting Started ## General Setup -Before you do anything else, you must first add the API keys and configure the node. +Once activated, go to WooCommerce > Settings > Payments and enable the ConnectIPS payment gateway. -If you are hosting Typesense locally / on your own server. -Then please see the steps here to generate API Keys -https://typesense.org/docs/0.22.1/api/api-keys.html +![Enable Payment Gateway](img/enable-payment-gateway.png) -Otherwise, if you have gone with Typesense cloud option - then once the cluster is set up. There will be an option to generate your API keys. +Once enabled, you will be able to see the ConnectIPS payment gateway in the list of payment methods. -![Api Keys Overview](img/api-keys-overview.png) -*Above Shows overview of API Keys* +![Payment Gateway](img/payment-gateway.png) -Clicking "Generate API Keys" - will generate and download API Keys to be used. Keep this file safe and secure for future use. +## Configure ConnectIPS -The Text file will have the following information -![API Keys Text](img/configuration-txt.png) +To configure the ConnectIPS payment gateway, go to WooCommerce > Settings > Payments > ConnectIPS and fill in the required fields. -* Protocol: [https] -* Port: [443] -* Admin API Key -* Search Only API Key -* Node \ No newline at end of file +![ConnectIPS Settings](img/connectips-settings.png) + +### Enable/Disable +Enable or disable the ConnectIPS payment gateway. + +### Title +The title of the ConnectIPS payment gateway. + +### Merchant ID +Merchant ID is and unique identifier to identify merchant in the system. Merchant ID will be provided by NCHL upon registering merchant for connectIPS Core Module on banks’ request + +### Application ID +Unique identification, which will be used to identify the accountdetails of the merchant’s application. A merchant can have multiple applications based on different banks account used for various shopping sites. Application Id will be provided by NCHL after registration. + +### Application Name +Application name to identify merchant as well as originating application. + +### Description +Text to be shown during checkout. + +### Private Key File +Digital certificate private key (pfx file/keystore) + +### Passphrase +Passphrase to decrypt the digital certificate private key (pfx file/keystore). + +### Basic Authentication Password +Basic authentication password provided in email for transaction validation. + +### User Redirection URLs +Before performing transactions, a static pair of successURL and failureURL has to be provided to the connectIPS integration support team. connectIPS itself handles user redirection and sends the user to whichever URL provided for testing after entering the OTP. Please provide full URL to the connectIPS integration support team. + +### Enable Log +Enable events logging from connectIPS + +### Enable Test Payment +Enable test payments from connectIPS on test URL instead of live URL. \ No newline at end of file diff --git a/docs/assets/banner-772x250.png b/docs/img/banner-772x250.png similarity index 100% rename from docs/assets/banner-772x250.png rename to docs/img/banner-772x250.png diff --git a/docs/img/connectips-settings.png b/docs/img/connectips-settings.png new file mode 100644 index 0000000..50c970c Binary files /dev/null and b/docs/img/connectips-settings.png differ diff --git a/docs/img/enable-payment-gateway.png b/docs/img/enable-payment-gateway.png new file mode 100644 index 0000000..a1a0925 Binary files /dev/null and b/docs/img/enable-payment-gateway.png differ diff --git a/docs/img/payment-gateway.png b/docs/img/payment-gateway.png new file mode 100644 index 0000000..961fdf2 Binary files /dev/null and b/docs/img/payment-gateway.png differ