Vimine 開發者文件

將 Vimine 整合到您的網站

讓會員使用自己的 Vimine 帳戶登入，讀取會員卡狀態，收集入會申請，在入場時核驗會員卡。文件完備的 REST API、零相依性的 SDK、為每個協會準備的沙箱。

app.js@vimine/sdk

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

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

// 在回呼頁面
await vimine.handleRedirect();
const card = await vimine.membership.get();
// → { verdict: 'valid', expires_at, card, … }

有效API 判定結果

使用 Vimine 登入

OAuth 2.1 加 PKCE。登入和授權同意頁面位於 vimine.network：會員的密碼絕不會經過您的頁面。

會員 API

個人資料、會員卡和判定結果（有效、已過期、需重新接受章程）、入會申請、接受章程、已連結的應用程式。

會員卡核驗

一個公開端點，只回答“有效 / 無效”，不含任何個人資料；另有公開金鑰，可離線驗證權杖。

沙箱

一個孿生協會，含各種狀態的虛構會員，測試用戶端立即生效。一鍵即可重設。

如何開始

協會的一位理事會成員在 Vimine 應用中開啟開發者頁面，登記一個用戶端（網站、原生應用或伺服器）並選擇權限。測試環境中的用戶端在沙箱中立即生效。
安裝 SDK：
終端機視窗
```
npm install @vimine/sdk
```

透過一次點選開始登入，並在回呼頁面處理返回：

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

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

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

// 在回呼頁面
await vimine.handleRedirect();
const card = await vimine.membership.get(); // { status, verdict, expires_at, card: { token }, … }

指南

使用 Vimine 登入完整流程、SDK、工作階段與登出。

沙箱與測試用戶端虛構會員、登入憑證、重設。

伺服器整合機密用戶端、client_credentials、會員卡狀態。

權限、錯誤與限制scope 一覽表、錯誤格式、速率限制。

嵌入與會員卡核驗您網站上的入會表單，以及入場時的核驗。

試用 API基於 OpenAPI 文件的互動式控制台。