Vimine for developers

Integrate Vimine into your site

Let members sign in with their Vimine account, read their card status, collect membership requests, verify cards at the door. A documented REST API, a zero-dependency SDK, a sandbox for every association.

Get started API reference

app.js@vimine/sdk

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

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

// on the callback page
await vimine.handleRedirect();
const card = await vimine.membership.get();
// → { verdict: 'valid', expires_at, card, … }

Validverdict from the API

OAuth 2.1 with PKCE. The sign-in and consent page lives on vimine.network: the member’s password never touches your pages.

Member API

Profile, card and verdict (valid, expired, statuto to re-accept), membership requests, statuto acceptance, connected apps.

Card verification

A public endpoint that answers “active / not active” with no personal data, and public keys to verify tokens offline.

Sandbox

A twin association with synthetic members in every state and test clients that are active right away. Reset in one go.

How to start

A director of the association opens Developers in the Vimine app, registers a client (website, native app or server) and picks the permissions. A client in the Test environment is active immediately in the sandbox.
Install the SDK:
Finestra del terminale
```
npm install @vimine/sdk
```

Start the sign-in from a click and handle the return on the callback page:

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

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

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

// on the callback page
await vimine.handleRedirect();
const card = await vimine.membership.get(); // { status, verdict, expires_at, card: { token }, … }

Guides

Sandbox and test clientsSynthetic members, credentials, reset.

Server integrationsConfidential clients, client_credentials, card status.

Permissions, errors and limitsThe scope table, the error format, the rate limits.

Embed and card verificationThe enrolment form on your site and verification at the door.

Try the APIThe interactive console on the OpenAPI document.