Best practices in building integrations
- Don't forget to define a way toAuthentication for use in CONNECT endpoints, especially in production, to prevent integrations from being public in the network environment;
- Use the fieldFlow Description to attach flowcharts, links to documentation and any other type of related contextualization;
- Standardize the nomenclature ofActions during the construction of flows according to their purpose, so that any references to their value are self-explanatory;
- Use the fieldDescription of the Action with a brief summary of the purpose of each Integration Action, this will facilitate future actions in the integration for maintenance and implementation of improvements;
- Always perform validation and treatment for error situations foreseen in the process (null keys, services offline, etc.). There are Actions dedicated to writing messages to the Integration Monitoring log, use them in flows to inform the Monitor about events or contextualize errors in the integration process;
- Instead of building a flow with all the integration procedures, divide the process logic into multiple flows (each responsible for one aspect of the integration) that will communicate with each other. One CONNECT integration can call another through the REST endpoints generated for each integration type;
- If your environment is Premise, pay attention to the expiration date of the certificates inTruststore to perform maintenance! HTTPS calls may be interrupted at the time ofcall handshake and will present the error ofPKIX.






