Alert EnterpriseWiki

Wavelynx

Wavelynx·AE_HSc_WavelynxConnectorGuide

Credential ProvideractiveWavelynx API version 2.5.0
Transports
rest
Direction
bidirectional
Authentication
X-API-Key header
Last updated
2024-12-10

Overview

The Wavelynx connector integrates AlertEnterprise with the Wavelynx Cloud mobile credential provisioning platform. Wavelynx is one of AE's three primary credential providers (alongside HID and LEGIC). This connector handles the AE-side ↔ Wavelynx-cloud interactions that issue and lifecycle mobile credentials destined for Apple Wallet and Google Wallet.

The deeper architectural model for Wavelynx — including the CM/CP topology where AE acts as Credential Manager and Wavelynx acts as Credential Provider — lives in content/integrations/wavelynx.yaml. This connector record describes the AE-side connector implementation: REST API surface, auth model, and the actors AE contributes to a composed deployment diagram.

Wavelynx is the credential provider that lets AE talk directly to Apple Pay; Google Wallet provisioning routes via NXP MIFARE2GO. AE owns lifecycle authority for Wavelynx-issued credentials.

Architecture

Composed from this connector's actors + edges. Trust zones are color-coded; trust crossings render as thicker lines.

Composing diagram — running ELK layout4 actors · 4 edges

Authentication

1 method supported

X-API-Key header
api-key

The Wavelynx Cloud REST API authenticates via an X-API-Key header carrying a per-partner API key issued by Wavelynx. Keys are environment-scoped (sandbox vs production).

Credential storage
AE connector configuration (encrypted at rest); production keys in Firebase Secret Manager

Prerequisites

Everything that must be in place for this connector to work, with the owner who's responsible.

Wavelynx API key

customer

Per-environment API key (sandbox + production) issued by Wavelynx. Stored as the X-API-Key header credential in AE connector config / Secret Manager.

Wavelynx Cloud partner registration

ae

AE-on-behalf-of-customer must be registered as a Wavelynx Cloud partner with the appropriate environment (sandbox + production) before the connector can issue credentials.

Data fields

2 fields mapped between AE Guardian and the vendor system.

AE fieldVendor fieldDescriptionDirectionRequired
Mobile CredentialWavelynx PassThe mobile credential issued to Apple Wallet or Google Wallet. AE creates, updates, suspends, resumes, and revokes via the connector.bidirectionalyes
Eligible UserWavelynx Cardholder ReferenceUser reference passed to Wavelynx for credential issuance. AE is the source of identity (no SCIM provisioning from AE → Wavelynx; credential is issued per request).outboundyes
Source materials
  • src/connectors/wavelynx/source.pdf p5 — Chapter 1, Supported Version
  • src/connectors/wavelynx/source.pdf p6 — Chapter 2, Connector Architecture
  • src/connectors/wavelynx/source.pdf p12 — Chapter 5, Security
  • content/integrations/wavelynx.yaml Integration record — CM/CP model + wallet routing
Verifying access
Desktop only

The AE Mobile Wiki needs a bigger screen.

The diagrams, comparisons, and animated flows aren't built for phones. Open this link on your laptop or desktop browser and you'll see the full reference.

wiki.alertenterprise.app

Same Google sign-in as the AE App Hub — you'll be in once you open it on a larger screen.