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 文档的交互式控制台。