Vimine für Entwickler

Integrieren Sie Vimine in Ihre Website

Lassen Sie Mitglieder sich mit ihrem Vimine-Konto anmelden, lesen Sie den Status ihres Ausweises, nehmen Sie Beitrittsanträge entgegen, prüfen Sie Ausweise am Einlass. Eine dokumentierte REST-API, ein SDK ohne Abhängigkeiten, eine Sandbox für jeden Verein.

Erste Schritte API-Referenz

app.js@vimine/sdk

import { Vimine } from '@vimine/sdk';

const vimine = new Vimine({
    clientId: 'vmc_…',
    redirectUri
});

// auf der Callback-Seite
await vimine.handleRedirect();
const card = await vimine.membership.get();
// → { verdict: 'valid', expires_at, card, … }

GültigErgebnis der API

Mit Vimine anmelden

OAuth 2.1 mit PKCE. Die Anmelde- und Einwilligungsseite liegt auf vimine.network: Das Passwort des Mitglieds berührt Ihre Seiten nie.

Mitglieder-API

Profil, Ausweis und Ergebnis (gültig, abgelaufen, Statuto erneut zu akzeptieren), Beitrittsanträge, Annahme des Statuto, verbundene Apps.

Ausweisprüfung

Ein öffentlicher Endpunkt, der „aktiv / nicht aktiv“ ohne personenbezogene Daten beantwortet, und öffentliche Schlüssel, um Tokens offline zu prüfen.

Sandbox

Ein Zwillingsverein mit synthetischen Mitgliedern in jedem Status und Test-Clients, die sofort aktiv sind. Mit einem Klick zurückgesetzt.

So fangen Sie an

Ein Vorstandsmitglied des Vereins öffnet in der Vimine-App Entwickler, registriert einen Client (Website, native App oder Server) und wählt die Berechtigungen. Ein Client in der Umgebung Test ist in der Sandbox sofort aktiv.
Installieren Sie das SDK:
Finestra del terminale
```
npm install @vimine/sdk
```

Starten Sie die Anmeldung mit einem Klick und verarbeiten Sie die Rückkehr auf der Callback-Seite:

import { Vimine } from '@vimine/sdk';

const vimine = new Vimine({ clientId: 'vmc_…', redirectUri: 'https://www.example.org/vimine/callback' });

button.addEventListener('click', () => vimine.signIn());

// auf der Callback-Seite
await vimine.handleRedirect();
const card = await vimine.membership.get(); // { status, verdict, expires_at, card: { token }, … }

Anleitungen

Mit Vimine anmeldenDer ganze Ablauf, das SDK, die Sitzung, die Abmeldung.

Sandbox und Test-ClientsSynthetische Mitglieder, Zugangsdaten, Zurücksetzen.

Server-IntegrationenVertrauliche Clients, client_credentials, Ausweisstatus.

Berechtigungen, Fehler und LimitsDie Scope-Tabelle, das Fehlerformat, die Ratenlimits.

Einbetten und AusweisprüfungDas Beitrittsformular auf Ihrer Website und die Prüfung am Einlass.

Die API ausprobierenDie interaktive Konsole zum OpenAPI-Dokument.