Skip to content

Commit

Permalink
Update getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
sachyya committed Nov 13, 2024
1 parent 1b0fc8d commit 159772b
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 15 deletions.
58 changes: 43 additions & 15 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -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
<a href="https://typesense.org/docs/0.22.1/api/api-keys.html" target="_blank" rel="no-opener no-follow" >https://typesense.org/docs/0.22.1/api/api-keys.html</a>
![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
![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.
File renamed without changes
Binary file added docs/img/connectips-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/enable-payment-gateway.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/payment-gateway.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 159772b

Please sign in to comment.