Autenticação da API

Aprenda como se autenticar com a API do FluenzR.

Autenticação da API

A API do FluenzR usa chaves de API para autenticação.

Obter uma chave de API

Pré-requisitos

  • Plano Pro ativo
  • Direitos de administrador na conta

Gerar uma chave

  1. Faça login no FluenzR
  2. Vá em Configurações > API
  3. Clique em Gerar uma nova chave
  4. Dê um nome descritivo à chave
  5. Copie imediatamente a chave exibida

Atenção A chave é exibida apenas uma vez. Guarde-a em um local seguro. Se você perdê-la, precisará gerar uma nova.

Usar a chave de API

Cabeçalho de autorização

Inclua sua chave de API no cabeçalho Authorization de cada solicitação:

curl -X GET "https://api.fluenzr.co/v1/contacts" \
  -H "Authorization: Bearer flz_sk_your_api_key_here" \
  -H "Content-Type: application/json"

Formato da chave

As chaves de API do FluenzR seguem este formato:

flz_sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  • flz: Prefixo FluenzR
  • sk: Secret key
  • xxx...: 32 caracteres alfanuméricos

Exemplos por linguagem

cURL

curl -X GET "https://api.fluenzr.co/v1/contacts" \
  -H "Authorization: Bearer flz_sk_abc123..." \
  -H "Content-Type: application/json"

JavaScript (fetch)

const response = await fetch('https://api.fluenzr.co/v1/contacts', {
  headers: {
    'Authorization': 'Bearer flz_sk_abc123...',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();

JavaScript (axios)

import axios from 'axios';

const client = axios.create({
  baseURL: 'https://api.fluenzr.co/v1',
  headers: {
    'Authorization': 'Bearer flz_sk_abc123...'
  }
});

const { data } = await client.get('/contacts');

Python (requests)

import requests

headers = {
    'Authorization': 'Bearer flz_sk_abc123...',
    'Content-Type': 'application/json'
}

response = requests.get(
    'https://api.fluenzr.co/v1/contacts',
    headers=headers
)

data = response.json()

PHP

<?php
$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://api.fluenzr.co/v1/contacts',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer flz_sk_abc123...',
        'Content-Type: application/json'
    ]
]);

$response = curl_exec($ch);
$data = json_decode($response, true);

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.fluenzr.co/v1/contacts')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer flz_sk_abc123...'
request['Content-Type'] = 'application/json'

response = http.request(request)
data = JSON.parse(response.body)

Gerenciar suas chaves de API

Ver chaves existentes

Em Configurações > API, consulte a lista de suas chaves:

NomeCriada emÚltimo usoAções
Produção01/01/202510/01/2025Revogar
Dev/Test05/01/202508/01/2025Revogar

Revogar uma chave

  1. Clique em Revogar ao lado da chave
  2. Confirme a revogação

Perigo A revogação é imediata e irreversível. Todos os aplicativos usando esta chave deixarão de funcionar.

Melhores práticas

Uma chave por ambiente

AmbienteChavePermissões
Produçãoflz_sk_prod_xxxTodas
Stagingflz_sk_stag_xxxTodas
Desenvolvimentoflz_sk_dev_xxxSomente leitura

Nunca expor chaves

Nunca faça:

  • Commit em um repositório Git
  • Incluir no lado do cliente (frontend)
  • Compartilhar por email/chat

Sempre faça:

  • Use variáveis de ambiente
  • Armazene em um gerenciador de segredos
  • Mantenha apenas no lado do servidor

Variáveis de ambiente

# .env (não faça commit)
FLUENZR_API_KEY=flz_sk_abc123...
// Node.js
const apiKey = process.env.FLUENZR_API_KEY;
# Python
import os
api_key = os.environ.get('FLUENZR_API_KEY')

Erros de autenticação

401 Unauthorized

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

Causas possíveis:

  • Chave de API ausente
  • Chave de API inválida
  • Chave de API revogada

403 Forbidden

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "API access requires Pro plan"
  }
}

Causas possíveis:

  • Conta em pausa após o fim do período de teste (API não disponível)
  • Chave de API sem as permissões necessárias

Segurança

Rotação de chaves

Altere suas chaves de API regularmente:

  1. Gere uma nova chave
  2. Atualize seus aplicativos
  3. Verifique se tudo funciona
  4. Revogue a chave antiga

Monitoramento

Monitore o uso de suas chaves:

  • Verifique o "último uso" regularmente
  • Identifique chaves não utilizadas
  • Detecte uso suspeito

Em caso de comprometimento

Se uma chave for comprometida:

  1. Revogue imediatamente a chave no FluenzR
  2. Gere uma nova chave
  3. Atualize seus aplicativos
  4. Analise os logs para detectar uso malicioso
  5. Entre em contato com o suporte se necessário