Best Practices

To ensure a smooth integration with the Flexiown Platform Payment API and maintain a high-quality user experience, follow these best practices:

Use the appropriate environment

Always use the appropriate base URL for the environment you are working with:

• Staging: https://pay.staging.teljoy.co.za/api/
• Production: https://pay.teljoy.co.za/api/

Test your integration thoroughly in the dev and staging environments before deploying to production.

Handle errors gracefully

Always check the HTTP status code and error payload returned by the API. Handle different error codes appropriately in your application, and display clear and informative error messages to your users when necessary.

Secure your API key

Treat your API key like a password. Do not expose it in client-side code or share it with unauthorized parties. Rotate your API key periodically to minimize the risk of unauthorized access.

Implement retries and timeouts

Network issues can cause API requests to fail or take longer than expected. Implement retries with exponential backoff and set appropriate timeouts in your application to handle these situations gracefully.

Monitor and log API usage

Monitor your API usage to detect any unusual activity or performance issues. Log API requests and responses to help with debugging and troubleshooting.

Optimize API calls

Minimize the number of API calls your application makes by caching data when appropriate and only requesting the data you need. This will help reduce the load on the API and improve the performance of your application.

Stay informed

Subscribe to our API updates and announcements to stay informed about new features, changes, and deprecations. This will help you keep your integration up-to-date and ensure a seamless user experience.