API N7
Documentação
Integre o score de reputação transacional em minutos. Nossa API N7 permite consultar e contribuir com dados de confiança em tempo real, reduzindo fraudes e melhorando aprovações.
{
"user_id": "1234-abcd",
"score": 87,
"risk_level": "low",
"insights": [
"Histórico de pagamentos consistente",
"Baixo risco de inadimplência"
],
"last_updated": "2024-01-15T10:30:00Z"
}Autenticação da API N7
Todas as requisições para a API N7 devem incluir um token de autenticação válido no header Authorization.
Obter token de API
Acesse seu dashboard e gere um novo token de API. Mantenha-o seguro e nunca o compartilhe publicamente.
Incluir no header
Adicione o token no header Authorization de todas as suas requisições usando o formato Bearer.
lynx_live_••••••••••••••••••••••••••••••••••••••••Segurança
Nunca exponha seu token em código client-side. Use sempre em requisições server-side ou através de proxies seguros.
curl -X GET "https://api.nSeven.com/v1/score" \ -H "Authorization: Bearer lynx_live_..." \ -H "Content-Type: application/json"
const response = await fetch('https://api.nSeven.com/v1/score', {
method: 'GET',
headers: {
'Authorization': 'Bearer lynx_live_...',
'Content-Type': 'application/json'
}
});
const data = await response.json();import requests
headers = {
'Authorization': 'Bearer lynx_live_...',
'Content-Type': 'application/json'
}
response = requests.get(
'https://api.nSeven.com/v1/score',
headers=headers
)Credenciais de teste
Use estas credenciais para testar a integração em ambiente de desenvolvimento:
lynx_test_1234567890abcdef1234567890abcdef12345678* Tokens de teste retornam dados simulados e não afetam dados reais
Endpoints Principais
Explore todos os endpoints disponíveis na API N7 com exemplos de requisições e respostas.
Base URL
https://api.nSeven.comConsultar Score de Reputação
/v1/scoreObtém o score de reputação e insights de um usuário específico
Parâmetros
user_idstringobrigatórioID único do usuário
include_insightsbooleanIncluir insights detalhados
Exemplo de Requisição
curl -X GET "https://api.nSeven.com/v1/score?user_id=1234-abcd&include_insights=true" \ -H "Authorization: Bearer lynx_live_..." \ -H "Content-Type: application/json"
Exemplo de Resposta
{
"user_id": "1234-abcd",
"score": 87,
"risk_level": "low",
"confidence": 0.94,
"insights": [
"Histórico de pagamentos consistente",
"Baixo risco de inadimplência",
"Ativo há mais de 12 meses"
],
"last_updated": "2024-01-15T10:30:00Z",
"data_points": 156
}Códigos de Erro
Enviar Evento de Feedback
/v1/eventsEnvia dados de feedback sobre uma transação para atualizar o score
Obter Perfil do Usuário
/v1/profile/{id}Retorna informações detalhadas do perfil de um usuário (requer permissões especiais)
Rate Limits
Limites podem ser aumentados para planos empresariais. Entre em contato para mais informações.
Exemplos por Setor
Veja como integrar a API nSeven em diferentes setores com exemplos práticos e casos de uso reais.
Análise de Crédito
FintechAvalie o risco antes de aprovar empréstimos ou cartões
Verificação de Entregadores
DeliveryValide a confiabilidade de entregadores e clientes
Validação de Vendedores
MarketplaceProteja compradores verificando vendedores confiáveis
Gestão de Transportadoras
LogísticaMonitore performance e confiabilidade de transportadoras
// 1. Consultar score do usuário
const response = await fetch('https://api.nSeven.com/v1/score?user_id=user_123', {
headers: {
'Authorization': 'Bearer lynx_live_...',
'Content-Type': 'application/json'
}
});
const scoreData = await response.json();
// 2. Tomar decisão baseada no score
if (scoreData.score >= 70) {
// Aprovar empréstimo
const approval = {
approved: true,
amount: 5000,
interest_rate: 2.5 // Taxa reduzida para bom score
};
// 3. Enviar feedback da aprovação
await fetch('https://api.nSeven.com/v1/events', {
method: 'POST',
headers: {
'Authorization': 'Bearer lynx_live_...',
'Content-Type': 'application/json'
},
body: JSON.stringify({
user_id: 'user_123',
event_type: 'credit_approval',
outcome: 'success',
amount: 5000,
metadata: {
product: 'personal_loan',
interest_rate: 2.5
}
})
});
} else {
// Rejeitar ou solicitar mais documentos
console.log('Score insuficiente:', scoreData.score);
}{
"user_id": "user_123",
"score": 85,
"risk_level": "low",
"insights": [
"Histórico de pagamentos excelente",
"Renda comprovada estável",
"Baixo endividamento atual"
]
}Dicas de Integração
Cache inteligente
Implemente cache para scores consultados recentemente, respeitando o TTL de 1 hora.
Feedback consistente
Envie eventos de feedback sempre que possível para melhorar a precisão dos scores.
Tratamento de erros
Implemente fallbacks para quando a API estiver indisponível ou retornar erro.
Monitoramento
Configure alertas para monitorar o uso da API e identificar padrões anômalos.
Sandbox da API
Teste a integração com dados simulados antes de implementar em produção. Sem custos ou limitações.
Credenciais de Teste
https://sandbox.api.nSeven.comlynx_test_1234567890abcdef1234567890abcdef12345678test_user_123Nota: Tokens de teste são públicos e seguros para uso em desenvolvimento. Eles retornam dados simulados e não afetam dados reais.
Dados de Exemplo
test_user_001Score: 85Usuário modelo com histórico excelente
test_user_002Score: 45Usuário com histórico de inadimplência
test_user_003Score: 67Usuário novo com poucos dados
Requisição
GET https://sandbox.api.nSeven.com/v1/score?user_id=test_user_123 Authorization: Bearer lynx_test_1234567890abcdef1234567890abcdef12345678 Content-Type: application/json
Resposta
Clique em "Testar API" para ver a resposta
Recursos do Sandbox
Próximos Passos
Teste todos os endpoints no sandbox
Implemente a integração em desenvolvimento
Solicite credenciais de produção
Webhooks em Tempo Real
Receba notificações instantâneas sobre mudanças de score, alertas de risco e eventos importantes diretamente na sua aplicação.
Tipos de Eventos
Score Atualizado
score.updatedDisparado quando o score de um usuário é recalculado
Quando é disparado:
Payload do evento:
{
"event": "score.updated",
"timestamp": "2024-01-15T10:30:00Z",
"data": {
"user_id": "1234-abcd",
"previous_score": 82,
"new_score": 87,
"change_reason": "positive_feedback",
"risk_level": "low",
"confidence": 0.94
}
}Alerta de Risco
risk.alertDisparado quando um usuário atinge um nível de risco crítico
Usuário Verificado
user.verifiedDisparado quando um usuário completa o processo de verificação
Configuração
Configurar endpoint
Defina a URL que receberá os webhooks
// Endpoint que receberá os webhooks POST https://sua-api.com/webhooks/nSeven // Headers obrigatórios Content-Type: application/json X-nSeven-Signature: sha256=... X-nSeven-Event: score.updated
Validar assinatura
Verifique a autenticidade dos webhooks
const crypto = require('crypto');
function validateWebhook(payload, signature, secret) {
const expectedSignature = crypto
.createHmac('sha256', secret)
.update(payload)
.digest('hex');
return `sha256=${expectedSignature}` === signature;
}
// Uso
const isValid = validateWebhook(
req.body,
req.headers['x-nSeven-signature'],
process.env.nSeven_WEBHOOK_SECRET
);Processar eventos
Implemente handlers para cada tipo de evento
app.post('/webhooks/nSeven', (req, res) => {
const event = req.headers['x-nSeven-event'];
const payload = req.body;
switch (event) {
case 'score.updated':
handleScoreUpdate(payload.data);
break;
case 'risk.alert':
handleRiskAlert(payload.data);
break;
case 'user.verified':
handleUserVerification(payload.data);
break;
}
res.status(200).send('OK');
});Configuração no Dashboard
Acesse a seção "Webhooks" no seu dashboard
Adicione a URL do seu endpoint
Selecione os eventos que deseja receber
Copie o secret para validação de assinatura
Melhores Práticas
Idempotência
Processe cada evento apenas uma vez usando o ID único do evento
Timeout adequado
Configure timeout de 30 segundos para responder aos webhooks
Retry logic
Implemente retry com backoff exponencial para falhas temporárias
Validação de assinatura
Sempre valide a assinatura HMAC para garantir autenticidade
Logs detalhados
Registre todos os eventos recebidos para debugging e auditoria
Processamento assíncrono
Processe eventos em background para resposta rápida
Segurança e Privacidade
Protegemos seus dados e dos seus usuários com os mais altos padrões de segurança e conformidade com a LGPD.
99.9% Uptime
Disponibilidade garantida
256-bit AES
Criptografia militar
LGPD Compliant
100% em conformidade
Zero Trust
Arquitetura de segurança
Proteção de Dados Pessoais
Cumprimos rigorosamente a LGPD e padrões internacionais de proteção de dados
Dados Anonimizados
Todos os dados são processados de forma anonimizada e criptografada
Consentimento Ativo
Coletamos dados apenas com consentimento explícito dos usuários
Minimização de Dados
Coletamos apenas dados estritamente necessários para o serviço
Fluxo de Processamento Seguro
Veja como seus dados são processados de forma segura e em conformidade com a LGPD
Coleta
Dados coletados com consentimento explícito
Anonimização
Remoção de identificadores pessoais
Processamento
Análise em ambiente criptografado
Entrega
Score entregue via API segura
Dúvidas sobre Segurança?
Nossa equipe de segurança está disponível para esclarecer qualquer dúvida sobre proteção de dados, conformidade ou implementação segura.
SDKs Oficiais
Integre a API N7 rapidamente com nossos SDKs oficiais para as principais linguagens de programação.
JavaScript/TypeScript
v2.1.0SDK oficial para Node.js e navegadores com suporte completo ao TypeScript
Python
v1.8.0SDK Python com suporte a asyncio e integração com frameworks populares
Go
v1.5.0SDK Go com performance otimizada e baixo overhead
Java
v1.3.0SDK Java com suporte a Spring Boot e frameworks empresariais
Instalação
npm install @nSeven/sdkyarn add @nSeven/sdkpnpm add @nSeven/sdkQuick Start
import { nSevenClient } from '@nSeven/sdk';
const client = new nSevenClient({
apiKey: 'lynx_live_...',
environment: 'production' // ou 'sandbox'
});
// Consultar score
const score = await client.getScore('user_123');
console.log('Score:', score.score);
// Enviar evento
await client.sendEvent({
userId: 'user_123',
eventType: 'payment',
outcome: 'success',
amount: 150.00
});Recursos
SDKs da Comunidade
SDKs mantidos pela comunidade para outras linguagens e frameworks
Ruby
SDK Ruby com suporte a Rails
BetaPHP
SDK PHP com suporte a Laravel
AlphaC#
SDK .NET Core e Framework
Em desenvolvimentoRust
SDK Rust com async/await
PlanejadoSwift
SDK iOS e macOS
PlanejadoKotlin
SDK Android e JVM
PlanejadoHistórico de Versões
Acompanhe todas as atualizações, melhorias e correções da API nSeven. Mantemos você informado sobre cada mudança.
v2.1.0
latestMajorNovos endpoints de webhooks e melhorias de performance
Webhooks em tempo real
featureAdicionados webhooks para notificações instantâneas de mudanças de score
Performance otimizada
improvementRedução de 40% no tempo de resposta da API
Novos insights de risco
featureAnálise mais detalhada dos fatores de risco
v2.0.5
stableCorreções de bugs e melhorias de estabilidade
v2.0.0
stableMajorNova versão da API com breaking changes
v1.8.2
deprecatedÚltima versão da API v1 - migração recomendada
Migração da API v1
A API v1 será descontinuada em junho de 2024. Recomendamos migrar para a v2 o quanto antes para aproveitar as novas funcionalidades e melhorias de performance.
Fique por dentro das atualizações
Receba notificações sobre novas versões, breaking changes e melhorias importantes da API.
