Going Live Checklist
Some tips and points to watch out for before going into production
Entering production with one or more of our APIs can be a significant milestone for your company. The ease of operating foreign exchange with just one API integration may seem impossible, but here at Remessa Online, we make it possible for your company to access the global market with just a few clicks.
However, to ensure that this partnership does not bring any headaches, we have identified some important points that we should review before going into production and actually starting to operate via API with Remessa Online.
Here are some tips and points of attention that we have gathered through our experience and are sharing with you so that you can be more successful in your integration:
Credentials and Security
Make sure that your integration with our APIs is protected against malicious attacks such as SQL injections, cross-site scripting (XSS), and other vulnerabilities.
- Ensure that you have received and successfully decrypted Live API credentials, storing them securely.
- Change sandbox credentials to production credentials. Requests for this change should be made through our Partner Solutions team.
- Include the x-token in the headers of your requests. This parameter is mandatory for requests made in a production environment.
- Ensure that access tokens and refresh tokens are also stored securely and only exposed to authorized persons.
- Implement a mechanism to obtain new access tokens upon expiration.
Webhooks
Our webhook service allows you to have more accurate communication with the changes that occur in your existing API operations. Using this functionality can save you resources and make updating statuses in your application easier.
- Make sure that you are correctly verifying the x-fxaas-signature header.
- Check that you are using the correct user-agent.
Our documentation explains step-by-step how to perform the verifications mentioned above. Just access this link.
Monitoring and Scalability
When integrating with our APIs, it's essential to consider the capacity and scalability of your system to handle growing workloads as demand increases. Here are some points to keep in mind:
- Plan the capacity of your API to ensure it can handle increasing workloads as demand grows.
- Consider using load balancing, caching, and other scalability techniques to ensure that the API continues to function smoothly as traffic increases.
- Implement monitoring mechanisms to track API performance, including response time, resource usage, and errors.
- Use API monitoring tools to detect performance and availability issues before they affect end-users.
Legal and Banking Considerations
If you need any kind of banking relationship with a financial institution, review the agreements and make sure there is nothing misaligned before going into production. In addition:
- Confirm that your customers' and/or operations' data is stored securely and has access restrictions;
- Understand if you need any kind of legal authorization to perform the services you intend to execute through our APIs;
- If you are operating outside of Brazil or from outside Brazil, seek to understand if you comply with the legal requirements of the foreign country before starting operations;
- Ensure compliance with the main data handling laws, such as LGPD and GDPR.
Support
Ensuring proper support is important for successful integration with our APIs. Here are some important points to keep in mind:
- Provide an easy way for your users to report any issues that may occur during the operation with the APIs.
- We offer full support to our partners in case of any issues with our application. Please contact our partner solutions team for support, and our technical team will analyze the issue.
- Make sure to provide detailed information when reporting any issues, including error messages, timestamps, and steps to reproduce the issue.
- In case of any doubts or questions about our APIs, please refer to our documentation or reach out to our partner solutions team for assistance.
- Ensure that you have the necessary resources and expertise to provide support to your users, including technical staff with knowledge of our APIs and relevant technologies.
Final Steps
Great, we're almost ready to go live! Before making the switch to production, we recommend reviewing a few points.
- Before releasing your integration to all users or use cases, do a rollout first. Start operating gradually and then pass your entire operation through the API. At this point, you can contact us for closer support.
- Test the entire flow and error cases to understand if your integration meets all the use cases available in the APIs.
- We provide support to partners who go live with some materials that can be used in product launches and communication plans. These will be provided by the partner solutions team.
All set? Switch it on!
Updated 10 months ago