PO Onboarding & Setup

Onboarding and Configuration

Initial Onboarding

Before your Program Operator organization can push data via webhooks or be crawled by the ECO Portal Search Worker, you must complete the initial registration process:

  1. Organization Registration: Contact it@eco-platform.org to register your organization as an accredited Program Operator and receive your immutable registration_authority_uuid.
  2. Obtain API Keys: Create an API key in the ECO Portal under Profile → API Keys or Organization Settings → API Keys using your verified PO account. This key is required for webhook publishing and validation requests.

Self-Service PO Node Management

Program Operators operating a self-hosted node can configure and maintain their node settings directly through the ECO Portal user interface under Organization Settings → PO Data:

  • Node Base URL: Set your public base URL (for example, https://data.example-po.org).
  • Endpoint Paths: Configure custom paths for Search, Get, and Health endpoints if they deviate from the default /resource/processes and /healthz endpoints.
  • Node Credentials: If your node requires basic authentication or custom headers, enter them securely in the portal. Credentials are stored encrypted and used exclusively by the background Search Worker during scheduled crawling.

Integration Checklist

Use this checklist to verify your organization’s readiness before going live:

For All Program Operators

  • Authoritative Hosting: Your full EPD files (JSON) are hosted securely and accessible via direct URI or API endpoint.
  • Data Standards Compliance: Datasets conform strictly to the ILCD+EPD v1.2 schema and ECO Platform DDR v1.1 rules.
  • PO Onboarding: Your organization is registered with ECO Platform and assigned a registration_authority_uuid.
  • API Key Generation: You have generated an API key for your Program Operator organization.

If Publishing via Webhook (Immediate Push)

  • Payload Assembly: Your publication pipeline formats dataset metadata according to the SearchItem schema.
  • URI Inclusion: The uri field in every record points to the hosted location of the full EPD document on your infrastructure.
  • Automation: Automated webhook calls trigger whenever an EPD is published, renewed, or updated.
  • Pre-Publication Validation: Your publishing pipeline tests datasets against POST /api/validate to ensure zero ingestion rejections.

If Operating a PO Node (Crawler Pull)

  • Endpoints Deployed: Search, Get, and Health endpoints are implemented (using soda4LCA or your custom stack).
  • Endpoint Configuration: Base URL and endpoint paths are registered in the portal under Organization Settings → PO Data.
  • Health Monitoring: Your health endpoint (/healthz or /v1/healthz) returns HTTP 200 when your data service is operational.
  • Node Reachability: Your endpoints are accessible to the public internet or reachable from the ECO Portal Search Worker IP ranges.