Interface IIntegrationConnector

Namespace

SESARWebHook.Core.Interfaces

Interface that all integration connectors must implement. Each connector handles synchronization with a specific external system.

public interface IIntegrationConnector

Properties

ConnectorId

Unique identifier for this connector (e.g., "zoho-crm", "sharepoint", "dynamics-365")

string ConnectorId { get; }

Property Value

string

Description

Description of what this connector does

string Description { get; }

Property Value

string

DisplayName

Human-readable name for display purposes

string DisplayName { get; }

Property Value

string

RequiredConfigurationKeys

List of required configuration keys for this connector

IEnumerable<string> RequiredConfigurationKeys { get; }

Property Value

IEnumerable<string>

Version

Version of the connector

string Version { get; }

Property Value

string

Methods

Initialize(Dictionary<string, string>)

Initializes the connector with its configuration

void Initialize(Dictionary<string, string> settings)

Parameters

settings Dictionary<string, string>

Configuration settings for the connector

ProcessManifestAsync(StoreManifest, WebhookContext)

Processes a StoreManifest from SESAR and sends it to the external system

Task<IntegrationResult> ProcessManifestAsync(StoreManifest manifest, WebhookContext context)

Parameters

manifest StoreManifest

The decrypted store manifest from SESAR

context WebhookContext

Additional context about the webhook request

Returns

Task<IntegrationResult>

Result of the integration operation

TestConnectionAsync()

Tests the connection to the external system

Task<bool> TestConnectionAsync()

Returns

Task<bool>

True if connection is successful

ValidateConfigurationAsync(Dictionary<string, string>)

Validates that the provided configuration is valid for this connector

Task<bool> ValidateConfigurationAsync(Dictionary<string, string> settings)

Parameters

settings Dictionary<string, string>

Configuration settings to validate

Returns

Task<bool>

True if configuration is valid