Steo by step integration instructions¶
1. Get access to Klix Merchant Console¶
Klix Merchant Console is a merchant self-service web-page for merchant profile and order data management. In order to receive access to Merchant Console contact firstname.lastname@example.org and request merchant onboarding in Klix. Make sure to specify IP address from which Klix solution will be accessed and e-mail address for logging into Merchant Console. Merchant Console invitation e-mail will be sent after the request has been reviewed.
2. Decide which integration scenario suits you best¶
There are three types of integration scenarios currently supported by Klix. Choose one depending on a type of your existing webshop:
Simple static merchant website integration. For each product separate Klix Instant Widget should be created and widget's HTML code should be placed on merchant's product page. In such case only specific product(s) can be purchased using specific widget and for each product(s) a separate widget should be created. Orders and payments are fully managed in Klix Merchant Console. Therefore this integration type is suitable for rather small product catalog (up to 10 - 15 products).
Klix Pay. Klix widget is integrated into custom built or standard e-commerce platform webshop and is used just as a payment option. In such case webshop's existing checkout page is responsible for collecting customer's information including delivery addressw. It means that Klix Single Klix Checkout Widget can be created to handle multi-product shopping carts and unlimited product catalogs. This requires callbacks implementation in merchant's web store.
Klix Pay example
Klix Checkout. Just as in Klix Pay scenario Klix widget is integrated into custom built or standard e-commerce platform webshop but in this case Klix is used as a full checkout solution. It means that order information is still maintained in merchant's webshop and during checkout process order information is passed to Klix wiget which is responsible for collecting customer's information including delivery address. Same as in Klix Pay scenario both after successful and failed payment merchant's callback is invoked by passing both order, customer and delivery information.
Klix Checkout example
3. Provide integration configuration in Merchant Console¶
Follow registration link in Merchant Console invitation e-mail and specify new password. After registration follow these steps to configure integration.
4. Add widget HTML code to your web-page¶
Add Klix widget HTML code to your product or checkout page depending on a type of used widget (instant, checkout, payment) and your webshop specifics. More information about widget configuration can be found on Widget page.
5. Implement purchase completed callback end-point¶
Callback end-point should be implemented so that Klix can send payment status to merchant.
6. Implement callbacks to navigate back to payment method selection page or display additional message in case of successfull payment¶
7. Test integration¶
Klix provides fully functional test environment that can be used to perform end to end integration implementation testing.
8. Sign agreement and request access to production environment¶
After integration has been successfully tested on test environment you can proceed with creadentials request for production.
9. Pass checklist on production environment¶
After integration configuration is completed on production environment you need to make test payments and pass few other tests from production readiness checklist.