Receiving Data From Yofi

1. Introduction

Yofi offers multiple flexible methods for delivering analyzed data, predictions, and insights back to your systems. This document outlines the various options available, allowing you to choose the method that best suits your technical capabilities, data needs, and latency requirements.

2. Data Delivery Methods

Yofi can send data back to you using the following methods:

• Query our REST API:

  • You can directly query Yofi's REST API to fetch specific data, including predictions, analytics, and aggregated insights.

  • This is ideal for on-demand data retrieval, integrating with custom workflows, or creating dynamic dashboards.

  • Refer to the Yofi API documentation for detailed specifications on available endpoints, parameters, and responses.

• Data Transfer:

  • Yofi supports transferring data to your systems using a variety of secure batch transfer methods:

    • Snowflake Data Sharing

    • Google BigQuery Data Sharing

    • AWS S3 Bucket Sharing

    • SFTP Transfer

    • Direct Database Query

  • These methods are suitable for large datasets, scheduled updates, or situations where real-time delivery is not required.

  • Discuss your requirements with your Yofi onboarding team to determine the best approach.

• Streaming Delivery:

  • For real-time, continuous data delivery, Yofi can stream data to your systems using the following platforms:

    • Google Cloud Pub/Sub

    • AWS Kinesis

    • Kafka/Redpanda

    • AWS EventBridge

  • Streaming is ideal for applications that require immediate access to insights for triggering actions or updating real-time interfaces.

  • Contact your Yofi support team to set up streaming data delivery.

• Direct Database Write:

  • Yofi can directly write processed data and predictions into your database.

  • This simplifies data integration by eliminating the need for intermediary services or custom code.

  • This approach requires configuration and direct access to your database. Contact your Yofi team for setup and security considerations.

• Send to Your Webhooks:

  • Yofi can send real-time notifications to your specified webhook endpoints whenever certain events occur or when new data is available.

  • This is a push-based method suitable for real-time alerts, triggering workflows, and integrating with microservice architectures.

  • You will need to provide and configure your webhook endpoints for this option.

• Embed Yofi UI:

  • Yofi offers an embeddable user interface that you can integrate directly into your application or website.

  • This allows your users to access insights, predictions, and visualizations directly within your existing interface.

  • No data transfer is required, as the data is presented directly through the embedded Yofi UI.

3. Choosing the Right Method

The optimal data delivery method depends on several factors:

• Data Volume:

  • For large datasets, batch data transfer, direct database write, or streaming options are recommended.

  • For smaller or on-demand datasets, the REST API might be sufficient.

• Latency Requirements:

  • If you need real-time access to data, use streaming, webhooks, or the embedded UI.

  • If latency is not critical, data transfer and database write options are appropriate.

• Complexity:

  • Consider your team's capabilities and existing infrastructure.

  • Some methods, like direct database write, require more configuration.

• Integration Needs:

  • If you need to create custom integrations, the REST API might be the most flexible option.

  • If data needs to be embedded directly into the UI, the embedded Yofi UI might be the preferred choice.