Network Initialization
Before your application can request programmatic bids or render spatial assets, you must initialize the WireSyndicate Core Engine and authenticate your client with the Edge Delivery Node.
Authentication Architecture
Authentication requires your Publisher Network Key. This cryptographically binds the telemetry emitted by the client to your publisher account, ensuring you are compensated for all validated impressions.
The 5-Step Deployment Pipeline
- Package Ingestion: Open your Unity Editor. Navigate to Window > Package Manager. Click the + icon, select Add package from git URL, and input our public repository URL (
https://github.com/WireSyndicate/wiresyndicate-unity-sdk.git). - Key Retrieval: Log into your Developer Dashboard on the WireSyndicate Web Portal. Copy your Organization ID or the specific Game Network Key.
- Scene Preparation: Open your initial loading scene. In the Unity Hierarchy, create an Empty GameObject and rename it to
[WireSyndicate_Core]. - Component Implementation: In the Unity Inspector, click Add Component, search for
WireSyndicateInitializer, and add it to the GameObject. Due to its[DisallowMultipleComponent]architecture, you can only attach one instance per GameObject. - Inspector Binding: In the Unity Inspector, configure the exposed fields on the
WireSyndicateInitializer:- Network Key: This is your Developer API Key. It cryptographically binds telemetry to your publisher account.
- Game Id: The unique identifier for your game on the platform, used for telemetry tracking.
- API Base URL: Tells the SDK where to connect. By default, it points to
https://api.wiresyndicate.comfor production. If running a local test server, update this to your local host address.
Architecture Note: The
WireSyndicateInitializeris a strictDontDestroyOnLoadSingleton. It features built-in auto-bootstrapping, meaning it will automatically handle internal dependencies like the Gaze Verification Engine.
- Package Ingestion: Download the latest
wire_syndicate_godot_sdk.zipfrom our releases page or clone the repository into youraddons/wire_syndicatedirectory. - Key Retrieval: Log into your Developer Dashboard on the WireSyndicate Web Portal. Copy your Organization ID or the specific Game Network Key.
- Plugin Activation: Open your Godot project. Navigate to Project > Project Settings > Plugins and enable the WireSyndicate SDK plugin. This registers the required singletons.
- Scene Preparation: Open your root scene. Add a new
WSPlacementNode(orws_placement_node.gdscript) into your scene tree. - Inspector Binding: Select the node. In the Inspector, paste your copied key into the Network Key field. Ensure the API Base URL is set to
https://api.wiresyndicate.com.
Architecture Note: The Godot plugin automatically registers the
WireSyndicateCoreAutoload (Singleton). You do not need to manually manage its lifecycle across scene transitions.
Warning: You must insert a valid Network Key or Organization ID into the Inspector slot. If this key is missing, invalid, or your account is suspended, the SDK will gracefully reject the Zero-Trust Handshake (403/404) and halt Edge telemetry.