Skip to content
View raw

Services and tooling

Hypercerts records live in the repositories of the people and organizations who publish them, spread across many servers. A set of services, most of them operated by the Hypercerts Foundation, lets people sign in and publish records, and lets applications find and read them.

This section describes each service at the level a project needs to integrate with Hypercerts: what it does, how it works, and how your application uses it. Applications can query indexed records through the Hypercerts API, or use the SDK where available. Running your own copy of a service is outside the scope of this documentation for now; each page links to the service's source code.

The Hypercerts stackRecords live in many PDSs, some hosted by the Hypercerts Foundation as Certified PDSs and some independent. The Hypercerts Relay collects changes from them, Jetstream filters those changes to Hypercerts and Certified records, and the Hypercerts API maintains a searchable view. Applications can query labelers directly for labels. Applications read through the SDK or the API. To write, users sign in through the entryway, from your application or from certified.app, where they manage their account. Signed-in users and groups acting through the Certified Group Service write to the same Certified PDSs. The feed service provides feeds to applications on its own.manage your accountYour applicationReads through the SDK or the API; writes as the signed-in userFeed Serviceready-made feedsEntrywaysigns users inCertified Group Servicegroup accountssign inact for a groupHypercerts APIsearchable XRPC APILabelerspublish labelslabel queriesSDK / APIHypercerts Relaycollects changesJetstreamfilters and replaysWhere records live: PDSsCertified PDSshosted by the FoundationIndependent PDSany AT Protocol hostusers writegroups writerecord changesreadingsigning in and writing
Records stay in each account's PDS. The relay and Jetstream deliver changes to the Hypercerts API for network-wide queries, while the entryway and CGS handle signing in and writing.

Components#

ComponentWhat it doesStatus
certified.appThe web app where people create and manage their Certified accountRunning
Certified PDSsHost Certified accounts and their records. A PDS (Personal Data Server) stores an account's repository of records.Running
EntrywaySigns users in to their Certified accountsUnder development; the Certified PDSs handle sign-in today
Certified Group ServiceLets several people manage one group account with different rolesRunning
Relay and JetstreamThe relay collects record changes from PDSs across the network; Jetstream filters them down to Hypercerts and Certified recordsRunning
Indexer and Hypercerts APIServes XRPC queries over a searchable view of Hypercerts and Certified recordsRunning
LabelersPublish labels about records and accounts, such as "likely test data", that applications can query directly. Running
Feed ServiceServes ready-made feeds of recent Hypercerts activityRunning

Running services#

All running endpoints are listed here and nowhere else, so there is one place to keep current as services are added or moved. Production is for live applications. Staging and test endpoints are listed when available; test instances may run development code and can be reset without notice.

Accounts and sign-in#

ServiceEnvironmentEndpointNotes
Certified PDSProductioncertified.oneProduction "Sign in with Certified" (ePDS)
Certified PDSStagingdev.certified.appStaging "Sign in with Certified" (ePDS)
Certified PDSTestepds1.test.certified.appDevelopment ePDS instance
Certified PDSTestpds1.test.certified.appStandard PDS backing the test group service
Sign-in (auth) serviceProduction, stagingauth.certified.one, auth.dev.certified.appHandles the email step of signing in; apps don't call it directly
certified.appProductioncertified.appWeb app where people manage their Certified accounts

Group accounts#

ServiceEnvironmentEndpointService DID
Certified Group ServiceProductiongroups.certified.appdid:web:groups.certified.app
Certified Group ServiceStagingdev.groups.certified.appdid:web:dev.groups.certified.app
Certified Group ServiceTesttest.groups.certified.appdid:web:test.groups.certified.app

Reading and discovery#

ServiceEnvironmentEndpoint
Hypercerts RelayProductionwss://relay.hypercerts.dev
Hypercerts RelayStagingwss://relay.staging.hypercerts.dev
JetstreamProductionwss://jetstream.hypercerts.dev
JetstreamStagingwss://jetstream.staging.hypercerts.dev
Hypercerts APIProductionapi.hypercerts.dev · endpoint explorer

Labels and feeds#

ServiceEnvironmentEndpointIdentity
Activity LabelerProductionactivitylabeler.hypercerts.devactivitylabeler.certified.one (did:plc:antf7bsm6f4ohkqfdckefyt7)
OrglabelerProductionorglabeler.hypercerts.devorglabeler.certified.one (did:plc:pswneepkd5lesumj7ejmkbal)
Feed ServiceProductionfeed.hypercerts.devdid:web:feed.hypercerts.dev
Feed ServiceStagingdev.feed.hypercerts.devdid:web:dev.feed.hypercerts.dev

Status pages#

PageCovers
certified.instatus.comProduction and staging services
test-certified.instatus.comTest services

Most services report their running version on a health endpoint, such as /health or /xrpc/_health. Each service page explains how to check it.