Sending Data to Yofi

1. Introduction

Yofi provides multiple flexible methods for partners to send their data for analysis. This document outlines the various options available, allowing you to choose the method that best suits your technical capabilities, data volume, and latency requirements.

2. Data Ingestion Methods

Yofi supports the following data ingestion methods:

• API Webhooks:

  • Use the real-time webhook API to send individual events as they occur (e.g., order creation, customer updates, returns, refunds).

  • Ideal for low-latency data transmission.

  • Detailed API specifications can be found in the Yofi Webhook API documentation.

• Streaming Ingestion:

  • For high-volume, real-time data streams, Yofi supports direct ingestion from the following platforms:

    • Google Cloud Pub/Sub

    • AWS Kinesis

    • Kafka/Redpanda

    • AWS EventBridge

  • This method enables continuous, real-time data transfer with minimal latency.

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

• Batch Data Transfer:

  • For larger historical datasets, or for data where real-time updates are not crucial, Yofi supports the following batch data transfer methods:

    • Snowflake Data Sharing

    • Google BigQuery Data Sharing

    • AWS S3 Bucket Sharing

    • SFTP Transfer

    • Direct Database Query

  • Batch data transfer is suitable for one-time transfers or scheduled data updates.

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

3. Choosing the Right Method

The optimal data ingestion method depends on several factors:

• Data Volume:

  • For high volumes of data, streaming ingestion and batch transfers are more suitable.

  • For low to moderate volumes, the webhook API may be sufficient.

• Latency Requirements:

  • If you need data to be processed in real time, use the webhook or streaming methods.

  • If latency is not critical, batch transfers can be more efficient.

• Technical Capabilities:

  • Consider your team's existing infrastructure, expertise, and tooling.

  • Choose the integration method that is easiest to implement and maintain.