API Overview

O Perfex CRM SaaS Module inclui uma REST API que permite gerenciar sua plataforma SaaS de forma programática. Isso é útil para:

• Páginas de cadastro personalizadas – Crie seu próprio fluxo de registro
• Integrações com terceiros – Conecte com ferramentas externas (Zapier, Integromat, apps personalizados)
• Automação de faturamento – Sincronize com sistemas de cobrança externos
• Monitoramento – Crie dashboards e ferramentas de monitoramento personalizados
• Apps mobile – Crie interfaces de gerenciamento mobile

Getting Started with the API

Step 1: Enable the API

1. Vá para SaaS Management → SuperAdmin Settings
2. Clique na aba API Settings
3. Ative a API em ON
4. Gere um token de API

Step 2: Authentication

Todas as requisições de API requerem autenticação via um token Bearer no header da requisição:

Authorization: Bearer YOUR_API_TOKEN_HERE

Step 3: Base URL

Sua URL base da API é:

https://yoursite.com/api/saas/

Substitua yoursite.com pelo seu domínio real.

---

Quick Example

Aqui está um exemplo rápido de criação de um tenant via API:

curl -X POST https://yoursite.com/api/saas/tenants \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Acme Corp",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "plan_id": 1,
    "subdomain": "acme"
  }'

Response:

{
  "success": true,
  "tenant_id": 42,
  "domain": "acme.yoursite.com",
  "message": "Tenant created successfully"
}

---

API Capabilities

Endpoint Group	What You Can Do
Tenants	Criar, ler, atualizar, excluir tenants
Plans	Listar, criar, atualizar planos
Subscriptions	Gerenciar assinaturas de tenants
Usage	Consultar uso e cotas de tenants

Para a lista completa de endpoints, veja a API Reference.

---

Rate Limiting

A API implementa rate limiting para proteger seu servidor:

• 100 requisições por minuto por token de API
• Os headers de rate limit estão incluídos em cada resposta

Se exceder o limite, você receberá uma resposta 429 Too Many Requests.

---

Best Practices

1. Mantenha seu token de API secreto – Nunca exponha em código client-side ou repositórios públicos
2. Use HTTPS – Sempre faça requisições de API via HTTPS
3. Trate erros adequadamente – Verifique códigos de status e trate erros apropriadamente
4. Use cache quando possível – Não consulte os mesmos dados repetidamente; cache respostas quando não mudam com frequência

informação

Precisa de uma integração personalizada? Se a API não cobre seu caso de uso, entre em contato através do support. Estamos constantemente expandindo a API com base no feedback dos clientes.

API Reference