Witness Chain
  • Introduction to Witness Chain
  • Infinity Watch
    • Proof of Location (Mainnet)
      • Introduction
      • Process flow
      • Architecture
      • Run a watchtower!
        • For Partner node runners
          • Running on Akash Cloud
          • Running on SuperNoderz
        • EigenLayer operators
          • Running a PoL Watchtower
          • Witness Chain AVS opt-in guide
        • At-home watchtowers
        • For DePIN/Validator Node provider
      • Demos
      • PoL Research
    • APIs
      • Campaign APIs
        • Key Terminologies
        • Authentication
        • Create Campaign
        • Edit campaign
        • Get Photo feed from campaign
        • Get Campaigns
      • Challenge APIs
        • Overview
        • Getting Started
  • Resources
    • Blogs
      • How Proof of Location Works
      • Redefining Geolocation Compliance: Witness Chain & Predicate
    • 🗞️Research
    • 🎙️Talks and Podcasts
    • 🤝Community
    • ⚖️Smart Contracts
    • File a bug
  • Archive
    • Introduction
    • Proof of Diligence Watchtower Protocol
      • How it works
      • Diligence Watchtower Roadmap
      • Watchtower Architecture
      • Chains watched
      • Smart Contracts
      • Quick Links
      • FAQs
    • For the node operators
      • Node requirements
      • Watchtower setup
        • [ARCHIVE] Mainnet Setup
          • L2 Archive Node Setup guide
        • Holesky Setup
          • L2 Archive Node Setup guide
        • Migration from archive to full node
      • Monitoring
    • Research
    • Keys Management
    • Proof of Bandwidth
      • Introduction
      • Architecture
      • For the node operators
        • Running a PoB Challenger Client
        • Running a PoB Prover Client
      • Demos
      • Research
    • 🤝Watchtower Protocol (Architecture v1)
      • 🗼How it works
      • 📅Watchtower Roadmap
      • 🏦Watchtower Architecture
      • 🔗Chains supported
Powered by GitBook
On this page
  • Overview
  • Early developer access
  • tl;dr
  • Key Features
  • Use Cases
  • Getting Started
  • Implementation Flow
  • Best Practices
  • Technical Considerations
  1. Infinity Watch
  2. APIs

Campaign APIs

PreviousAPIsNextKey Terminologies

Last updated 2 months ago

Overview

The Witness Chain Campaign APIs provide developers with powerful tools for requesting tasks and observations in the real world. They work in conjunction with the InfinityWatch app, which acts as a portal to the physical world. These APIs enable developers and organizations to crowdsource authentic, geo-verified photographs by launching campaigns on the InfinityWatch app and rewarding participants through a gamified system.

Early developer access

Please fill out this for early developer access to the campaign API and the app

tl;dr

  • The Create Campaign API lets you create campaigns in InfinityWatch app. For example, you can use this endpoint to create a campaign to capture photos of your new coffee rollouts from your coffee lovers at the stores. You can target your campaigns based on locations that match the product profile that you want to roll out to.

  • The Get Campaign Report API lets you get all the photos from a specific campaign

  • The Get Campaigns API lets you get a list of all campaigns created

Key Features

Location Verification

  • Create geofenced campaigns that only accept tasks and observations from specific geographic areas

  • Capture observations via a trusted camera integrated into the InfinityWatch app

  • Define custom radius boundaries for photo submissions

  • Ensure observations are captured at the claimed location and time through built-in verification utilizing Witness Chain's PoL (Proof of Location) network

Reward System (COMING SOON)

  • Implement campaign points for successful photo submissions

  • Set custom campaign points per task

  • Define campaign-wide campaign point pool

  • Track and manage fuel consumption for user activities

Campaign Management

  • Create individual, group, or task-based campaigns

  • Set campaign duration with start and end dates

  • Control submission limits

  • Add rich media content (banners and posters) to campaigns

  • Tag and categorize campaigns for better organization

Use Cases

Campaigns enable your code to actuate and observe the physical world. This has applications for all use cases that need on-the-ground operations.

  1. Verifiable News

    1. Request observations - verified photos - at local news hotspots

    2. Discover new local events

    3. Gather and summarize the latest intelligence on events happening near you

  2. Real community engagement and incentivization

    1. Request communities to attest their physical attributes

    2. Prevent farmers and Sybil attacks

    3. Ensure fair incentive distribution with custom policies

  3. Infrastructure expansion and monitoring

    1. Incentivize new infrastructure deployment

    2. Track deployment progress

    3. Monitor maintenance needs

    4. Document facility conditions

  4. Marketing campaigns

    1. Collect authentic user-generated content

    2. Verify in-store promotions

    3. Document brand activations

  5. Community Engagement

    • Organize local clean-up documentation

    • Create neighborhood improvement initiatives

    • Run citizen journalism projects

Getting Started

To begin using the Campaign APIs:

  1. Complete the authentication flow using pre-login and login endpoints

  2. Create a campaign with specific geographic boundaries

  3. Set reward parameters to incentivize participation

  4. Monitor and collect verified photo submissions

Implementation Flow

  1. Authentication

    • Secure your API access through two-step authentication

    • Maintain session tokens for continuous operation

  2. Campaign Creation

    • Define campaign parameters

    • Set geographic boundaries

    • Configure reward structure

  3. Photo Collection

    • Receive location-verified submissions

    • Track campaign progress

  4. Campaign Management (COMING SOON)

    • Reward campaign points

    • Monitor submission rates

    • Adjust campaign parameters as needed

    • Access submission data and analytics

Best Practices

  1. Geographic Targeting

    • Set appropriate radius boundaries based on campaign needs

    • Consider population density when defining target areas

    • Use recommended coordinate precision for accurate location verification

  2. Reward Structure

    • Balance campaign point amounts with the campaign budget

    • Consider task complexity when setting campaign points

    • Implement fair fuel consumption rates

  3. Campaign Duration

    • Set realistic timeframes for photo collection

    • Consider seasonal factors affecting outdoor photography

    • Plan for peak participation periods

  4. User Experience

    • Provide clear campaign descriptions

    • Use high-quality campaign banners and posters

    • Set achievable submission targets

Technical Considerations

  • All API endpoints require authentication

  • Implement proper error handling for geographic verification

  • Cache authentication tokens appropriately

  • Monitor campaign points pool consumption

  • Handle timezone differences in campaign scheduling

The Campaign APIs provide a robust foundation for building location-aware photo collection systems while maintaining data integrity through verification mechanisms. Whether you're building a community engagement platform or a marketing campaign tool, these APIs offer the flexibility and features needed for successful implementation.

Please fill out this for early developer access to the API and the app

form
Create Campaign
Get Photo Feed from Campaign
Get Campaigns
form