Developer Docs

GS1 Digital Link API

A comprehensive RESTful API for product management, QR generation, resolver link configuration, scan analytics, serial management, and event subscriptions — with secure authentication, granular permission scopes, and a realtime streaming feed.

API Overview

Six resource areas covering the complete GS1 Digital Link lifecycle — from product registration through scan analytics.

Products

Register, update, list, and manage products with GTIN validation and GEPIR verification.

QR Generation

Generate GS1-compliant QR codes in multiple print-ready formats with customization options.

Resolver Links

Configure link types per product with device-aware routing rules.

Analytics

Query scan data by product, geography, device type, and time range.

Serials

Manage serial pools, assign serials, and track lifecycle states.

Webhooks & Streaming

Subscribe to product events and access realtime scan data via webhooks and SSE.

Authentication

Two authentication methods to fit different integration patterns.

API Key

Simple integrations

Pass your API key in a request header. Keys are configured with granular scopes and optional expiry dates. Ideal for server-to-server integrations where the key can be stored securely.

OAuth2 + PKCE

Third-party apps

For applications acting on behalf of users or third-party integrations. Uses the authorization code flow with Proof Key for Code Exchange (PKCE) to prevent authorization code interception.

Integration Highlights

Built for production workloads with secure, predictable, and developer-friendly patterns.

RESTful API

Full CRUD operations across products, QR codes, resolver links, analytics, and serial management. JSON request/response format with comprehensive error handling.

Secure Authentication

API key authentication for server-to-server integrations, and OAuth2 with PKCE for third-party applications. Granular permission scopes control access to specific functionality.

Event-Driven Webhooks

Subscribe to product and scan events with cryptographically signed payloads. Integrate scan activity directly into your existing security and analytics infrastructure.

Realtime Streaming

Server-Sent Events (SSE) endpoint for live scan data. Monitor product engagement in real time with automatic reconnection and heartbeat support.

Production-Ready Rate Limits

Designed for production workloads with predictable capacity. Enterprise plans include higher rate limits and dedicated support.

Batch Operations

Batch QR code generation, bulk product import, and pool-based serial assignment for high-volume workflows.

Get Started with the API

Request API access to receive your credentials, full endpoint documentation, request/response schemas, code examples, and access to the interactive API explorer.

Start Building with Sprouter GS1

Get your API credentials and start integrating GS1 Digital Link into your product infrastructure.

Developer FAQ

How do I authenticate with the GS1 API?

Two methods: API key authentication for simple server-to-server integrations, or OAuth2 with PKCE for programmatic access and third-party applications. API keys are configured with granular scopes and optional expiry dates.

What webhook events are available?

Sprouter supports webhook subscriptions for scan activity, product lifecycle changes, batch events, and engagement milestones. All webhook payloads are cryptographically signed for verification. Full event documentation is available after API access is granted.

Is there a realtime scan feed?

Yes. Sprouter provides a Server-Sent Events (SSE) streaming endpoint for live scan data, enabling real-time monitoring of product engagement. Full connection details are available in the authenticated API documentation.

Last updated: April 2026