Architecture Documentation

Generated at 2026-04-09 14:33:54 UTC

Overall Architecture

Shiprocket Ads Core is a Spring Boot 3 microservice exposing web APIs for Shiprocket Ads. It validates seller/platform context, manages ad insights and operations through Meta Graph API and Google Ads API, supports CSV-driven workflows, and performs asynchronous processing via Kafka. It persists operational data in MySQL and MongoDB, uses Redis for caching/shared state, and integrates with AWS S3 (file storage) and AWS SES/SMTP (email). It also calls internal Shiprocket services (Aggregator, Communication, Edge/Checkout public-api S2S, Ads Python service) and optionally uses external AI/LLM providers (OpenAI, Google Vertex AI/Gemini, OpenRouter). Configuration is sourced from Spring Cloud Config Server. Observability is provided via Actuator and OpenTelemetry exporting to an OTLP collector (e.g., SigNoz). A secondary repo entry (shiprocket-ads-core@tmp) lacks code; its details are treated as non-authoritative and are not modeled beyond the primary service.

Overall architecture diagram

Overall DFD

Overall DFD diagram

Services

shiprocket-ads-core

Spring Boot 3 service providing core capabilities for Shiprocket Ads. It exposes web APIs, integrates with Meta (Facebook) and Google Ads for insights/management, validates seller/platform context, processes CSV-based workflows, publishes/consumes Kafka topics for async processing, persists operational data in MySQL and MongoDB, and uses Redis for caching and shared state. Includes observability via Actuator and OpenTelemetry.

Repo: shiprocket-ads-core

shiprocket-ads-core@tmp

Core service for managing Shiprocket advertising operations. Repository metadata contains no code or files, so responsibilities and integrations are inferred at a high level and should be validated once source content is available.

Repo: shiprocket-ads-core@tmp