Integre o Vimine ao seu site

Entrar com Vimine

OAuth 2.1 com PKCE. A página de login e de consentimento fica em vimine.network: a senha do associado nunca passa pelas suas páginas.

API do associado

Perfil, carteirinha e veredito (válida, vencida, statuto a aceitar de novo), pedidos de adesão, aceitação do statuto, apps conectados.

Verificação das carteirinhas

Um endpoint público que responde “ativa / não ativa” sem nenhum dado pessoal, e chaves públicas para verificar os tokens off-line.

Sandbox

Uma associação gêmea com associados sintéticos em todos os status e clientes de teste ativos na hora. Redefinida de uma só vez.

Como começar

1. Um dirigente da associação abre Desenvolvedores no app Vimine, registra um cliente (site, app nativo ou servidor) e escolhe as permissões. Um cliente no ambiente Teste fica ativo na hora, no sandbox.

2. Instale o SDK:

   npm install @vimine/sdk

3. Inicie o login a partir de um clique e trate o retorno na página de callback:

   app.js

   import { Vimine } from '@vimine/sdk';
   
   const vimine = new Vimine({ clientId: 'vmc_…', redirectUri: 'https://www.example.org/vimine/callback' });
   
   button.addEventListener('click', () => vimine.signIn());
   
   // na página de callback
   await vimine.handleRedirect();
   const card = await vimine.membership.get(); // { status, verdict, expires_at, card: { token }, … }

Guias

Entrar com VimineO fluxo completo, o SDK, a sessão, o logout.

Sandbox e clientes de testeAssociados sintéticos, credenciais, redefinição.

Integrações de servidorClientes confidenciais, client_credentials, status da carteirinha.

Permissões, erros e limitesA tabela de escopos, o formato dos erros, os limites de requisições.

Incorporação e verificação das carteirinhasO formulário de adesão no seu site e a verificação na entrada.

Experimente a APIO console interativo sobre o documento OpenAPI.