Pinaculo Authenticator Client Library

Uma biblioteca robusta e segura para integração com o microserviço de autenticação da Pinaculo Digital. Projetada para simplificar a autenticação de usuários em projetos internos, esta biblioteca oferece uma interface eficiente e fácil de usar para comunicação com a API de autenticação.

✨ Visão Geral

A Pinaculo Authenticator Client Library permite que desenvolvedores integrem rapidamente funcionalidades de autenticação em seus projetos, garantindo segurança e conformidade com os padrões da Pinaculo Digital. A biblioteca suporta autenticação baseada em chaves de projeto e é altamente configurável para atender às necessidades de diferentes aplicações.

📦 Instalação

Para começar a usar a biblioteca, instale-a via npm:

npm install pinaculo-authenticator

Ou, de forma abreviada:

npm i pinaculo-authenticator

🔑 Pré-requisitos

Antes de usar a biblioteca, certifique-se de configurar corretamente o ambiente do seu projeto. Você precisará criar um arquivo .env na raiz do projeto com as seguintes variáveis:

Chave única do projeto, fornecida pela Pinaculo Digital

PROJECT_KEY=CHAVE_DO_PROJETO_ATUAL

URL base da API de autenticação

AUTHENTICATOR_URL=https://pinaculo-authenticator/

Nota: Substitua CHAVE_DO_PROJETO_ATUAL pela chave fornecida pela equipe da Pinaculo Digital e verifique se a AUTHENTICATOR_URL aponta para o endpoint correto da API.

Pinaculo Authenticator Client Library

Uma biblioteca robusta e segura para integração com o microserviço de autenticação da Pinaculo Digital. Projetada para simplificar a autenticação de usuários em projetos internos, esta biblioteca oferece uma interface eficiente e fácil de usar para comunicação com a API de autenticação.

✨ Visão Geral

A Pinaculo Authenticator Client Library permite que desenvolvedores integrem rapidamente funcionalidades de autenticação em seus projetos, garantindo segurança e conformidade com os padrões da Pinaculo Digital. A biblioteca suporta autenticação baseada em chaves de projeto e é altamente configurável para atender às necessidades de diferentes aplicações.

📦 Instalação

Para começar a usar a biblioteca, instale-a via npm:

npm install pinaculo-authenticator

Ou, de forma abreviada:

npm i pinaculo-authenticator

🔑 Pré-requisitos

Antes de usar a biblioteca, certifique-se de configurar corretamente o ambiente do seu projeto. Você precisará criar um arquivo .env na raiz do projeto com as seguintes variáveis:

Chave única do projeto, fornecida pela Pinaculo Digital

PROJECT_KEY=CHAVE_DO_PROJETO_ATUAL

URL base da API de autenticação

AUTHENTICATOR_URL=https://pinaculo-authenticator/

Nota: Substitua CHAVE_DO_PROJETO_ATUAL pela chave fornecida pela equipe da Pinaculo Digital e verifique se a AUTHENTICATOR_URL aponta para o endpoint correto da API.

🚀 Como usar

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { ConfigModule } from '@nestjs/config';
import { AuthModule } from 'pinaculo-authenticator';

@Module({
imports: [ConfigModule.forRoot(), AuthModule], //Importe esses dois modulos
controllers: [AppController],
providers: [AppService],
})

export class AppModule {}

Com isso a documentação do micro serviço sera automaticamente gerada para o seu aplicativo, tamo junto