Overview

This page explains the way Hoox API works

Hoox is a zero knowledge platform. That means that we do not handle nor keep private identifiable data. Therefore, phone numbers and email addresses are encrypted using our patent pending, asymmetric hashing algorithm. The cipher (hash) is created on the client or server in a way that the original piece of data (email or phone number) can never be retrieved from the hash. To achieve this concept, Hoox integration contains two steps:

1. Integrating the encryptor in your client or server.

2. Implementing Hoox API.

If you wish not to integrate Hoox encryptor in your client or server, you can still use Hoox by implementing the Hoox Encrypt API call. This way, no integration is needed and you may use Hoox solely by API calls.

To learn more about Hoox encryptor integration - please visit the Implementing Hoox Encryptor page.

API Calls

Hoox Merchants API contains five main calls:

1. Hoox Encrypt

Use this API call to encrypt emails or phone numbers without having to implement the Hoox encryptor. Hoox keeps full privacy and never uses personal identifiable data. Therefore, emails or phone numbers are encrypted into a irreversible cipher (hash), meaning that the original piece of data (email or phone number) can never be retrieved from it. If you do not wish to integrate Hoox Encryptor in your website, encryption can be achieved using this API call.

2. Request Offer

Use this API call to request offers from Hoox. If an offer is granted, you should present the corresponding banner to let buyers know that they are entitled for the offer. Offers are a verity of incentives, funded by Hoox trusted partners, and are aimed to incentivize buyers. They may a fixed value discount, cash-backs, free shipping etc.

3. Validate Hashes

Use this API call to make sure the buyer is using the targeted card. In some use cases, the incentive to the buyer is conditional on using a specific credit card. For example. if the buyer uses Mastercard to complete the transaction, they will get $5 discount. In this cases, Validate Hashes is sent to Hoox to make sure the correct card is in use. This is achieved in a J2 or J5 call to the processor, followed by a Validate Hashes API call to Hoox with the card's last 4 digits.

4. Transaction

Use this API call to inform Hoox that the transaction was completed, meaning the the buyer redeemed the offer.

5. Cancel Transaction

Use this API call to cancel a transaction that was sent to Hoox in case the buyer cancelled a transaction on your website or mobile app.

This API call is blocked by default and can be used only after registering the usage with Hoox. For more information, please contact us.