API Integration Examples

View Categories

API Integration Examples

1 min read

API Integration Examples #

Common integration patterns.

WordPress Plugin Integration #

Validate License on Activation #

  • User enters license key in plugin settings
  • Plugin sends POST to /licenses/validate
  • If valid, store key and activate
  • If invalid, show error message

    • Activate Using Key-Based Endpoint (Recommended, v1.2.0) #

  • Call POST /licenses/activate with license_key and site_url
  • No need to look up internal license ID first
  • Store activation confirmation locally
  • Check license_type, activation_limit, license_duration in response to show correct UI

    • Periodic Check-In #

  • Daily cron job in your plugin
  • Send POST to /activations/check-in
  • Updates last_checkin_date
  • Helps identify stale activations

    • Activation Workflow #

    Activate Site (Key-Based, v1.2.0 – Recommended) #

  • POST to /licenses/activate with { license_key, site_url }
  • Store returned activation confirmation
  • Read license_type and activation_limit from response for UI

    • Activate Site (ID-Based, Legacy) #

  • Validate license first to get license ID
  • If valid and slots available
  • POST to /licenses/{id}/activate
  • Store activation ID locally

    • Deactivate Site (Key-Based, v1.2.0 – Recommended) #

  • POST to /licenses/deactivate with { license_key, site_url }
  • Remove local activation data
  • Slot becomes available

    • Deactivate Site (ID-Based, Legacy) #

  • DELETE to /activations/{id}/deactivate
  • Remove local activation data
  • Slot becomes available

    • Best Practices #

    PracticeReason
    Use key-based endpointsSimpler – no ID lookup step needed
    Cache validationReduce API calls
    Store activation confirmationNeeded if using legacy deactivation
    Handle errors gracefullyBetter UX
    Use check-inKeeps activation fresh
    Read variation metadataShow correct tier info in UI

    Related Topics #

    • [Validate License Endpoint](#)
    • [Activation Endpoints](#)
    • [Key-Based Activate and Deactivate](#)
    • [Error Handling](#)

    Leave a Reply