PEP Integration Best Practices
In this guide, we'll uncover the essential best practices ensuring a seamless integration process. From thorough documentation review to secure authentication and error handling, we'll navigate the integration landscape with confidence.
1- Thoroughly Review Documentation: Familiarize yourself with our API documentation to understand its capabilities, endpoints, parameters, and usage instructions.
2- Authentication: Implement secure authentication using OAuth to ensure authorized access to our API endpoints, and properly secure the OAuth Client ID and Client Secret.
3- Error Handling: Handle errors gracefully by checking for error responses and implementing appropriate error-handling logic in your application. Consider implementing retry mechanisms for transient errors.
4- Retry Operations: Implement retry logic for transient errors such as network timeouts or temporary service unavailability. Use exponential backoff strategies to gradually increase retry intervals.
Operator API
The operator API refers to API endpoints that you need to integrate to allow PEP to send requests to you or fetch data required by any PEP process.
Bonus
If you want to allow PEP to assign bonuses through your bonus system, you are required to implement the Assign Bonus API. This API allow PEP to send bonuses in different ways, for example in Marketing campaigns in the CRM or as a reward when a player upgrades levels or ranks, as well as when a mission objective is accomplished.
As a best practice we recommend that you implement the Get Bonuses API, this endpoint allows PEP to automatically allow Admin operators to list the bonuses available in your bonus system, and Admin Operators can easily pick the desired bonus for loyalty rewards or in CRM marketing campaigns:
If you don't define this optional API, the operator needs to manually add the bonus unique identifier or bonus offer unique identifier, which can cause errors due to human intervention in the process. If PEP makes the API call and the endpoint is not implemented an input type text is used to allow operators to enter the bonus unique identifier:
Reconciliation API
If you are using the CRM and by regulation there is information that your players need to meet for receiving Marketing campaigns, PEP can identify if there is missing information for the players that you register in our platform.
To ensure data alignment between your platform and PEP, it's essential to develop a reconciliation process. This process serves as a fail-safe to guarantee that if PEP detects any missing player information, you (the operator) will be notified to sync the missing information using PEP's player CRUD operations. To avoid regulation issues the reconciliation requests are stored in an audit log.
As a best practice, we recommend implementing the Reconciliation API, so that you can send us all the player information using the Player Data CRUD operations
Player Information
The best practices to register players and player information are described in this document section:
Take a look at this documentation to see how to properly send player information data to PEP.
Loyalty - Gamification
If you are only using our loyalty/gamification, the minimal integrations that we need are:
Transactional Information:
- Game Transaction Event Round: Applies for casino game transactions
- Sport Transaction Event
- Money Transaction Event
- Bonus Granted
Player Events: