The Mirror API endpoint allows you to post data and receive the same data as a response. The endpoint is a versatile tool to ensure the correctness, reliability, and performance of integration flows during various stages of development and testing. To use the endpoint:
- Gather sample data for an export, import, or lookup step.
- Create an integrator.io connection.
- Create and configure your integrator.io export, import, or lookup step using your connection. Use the REST API form view.
- For the relative URI, use /v1/mirror.
- Specify POST as the HTTP method.
- Add the sample data in the request body.
This endpoint is useful when building and testing integrations for:
- Testing and Debugging: You can use the endpoint for testing and debugging purposes. By sending data to this endpoint, you can quickly verify that it is being transmitted correctly and understand how it's processed within the integration flow.
- Mocking Data: In the early stages of development or when certain systems are not readily available, you can use the mirror endpoint to simulate the behavior of a real endpoint. This is especially helpful for testing without affecting actual systems.
- Endpoint Validation: The mirror endpoint can validate that the data formatting, structure, and content match the destination application. This is particularly valuable when working with complex data transformations.
- Training and Onboarding: For training purposes or onboarding new team members, the mirror endpoint provides a safe and controlled environment to experiment with data without the risk of impacting actual systems.
- Documentation and Examples: The mirror endpoint can serve as a practical example in documentation. It provides a straightforward use case that you can reference when learning to interact with integrator.io and its APIs.
- Circuit Breaker Testing: During development or maintenance, you may intentionally break certain components or connections within the integration flow to see how the system responds. The mirror endpoint allows you to observe the behavior without disrupting the actual data flow.
- Performance Testing: You might use the mirror endpoint to assess the performance of your integration flows by sending a significant amount of data and analyzing how quickly it is processed and returned.