Configurando aplicações OAuth 2.0 na Soft CS

A criação de aplicações OAuth na Soft CS é gerenciada através do menu Configurações > API, que abre a tela Aplicações API — um painel centralizado para gerenciar todas as aplicações OAuth da conta.

Restrição de acesso: Esta funcionalidade é exclusiva para usuários com perfil ADMIN ou GESTOR. Usuários sem essas permissões são redirecionados automaticamente para a página inicial.

1. Acessar a tela de aplicações

No menu lateral, navegue até:

• Configurações → API

A tela Aplicações API exibe:

• Nome da aplicação
• Client ID
• Status (Ativo ou Inativo)
• Ações de edição e exclusão

Se nenhuma aplicação estiver cadastrada, a interface apresenta um estado vazio com o botão Nova aplicação.

2. Iniciar a criação

Clique em Nova aplicação para acessar a página dedicada de criação (não é um modal ou sheet).

3. Preencher os dados da aplicação

Nome

• Obrigatório
• Máximo de 100 caracteres
• Identificador interno da aplicação OAuth

Descrição

• Opcional
• Máximo de 240 caracteres
• Campo para documentar o propósito da aplicação

URLs de Redirecionamento

• Obrigatório: pelo menos uma URL
• Todas as URLs devem usar https://
• URLs duplicadas são normalizadas automaticamente
• Suporta múltiplos callbacks no mesmo cadastro

Escopos de Acesso

Os escopos são organizados em grupos colapsáveis:

• Identidade
• Clientes
• Tickets
• Oportunidades
• Tarefas
• Planos de Sucesso
• Contratos
• Cobranças
• Recebimentos
• Contatos
• Health Scores
• Analytics

Regras:

• Obrigatório: selecionar pelo menos um escopo
• Escopos de escrita e exclusão dependem automaticamente do escopo de leitura correspondente
  • Exemplo: ao selecionar clients:write, a Soft CS garante automaticamente clients:read

4. Salvar a aplicação

Após preencher todos os campos:

1. Clique em Salvar
2. A Soft CS valida o formulário
3. Campos inválidos são destacados em caso de erro
4. Se validado, a aplicação é criada com:
   • client_id gerado automaticamente
   • client_secret gerado automaticamente
   • Escopos permitidos configurados
   • Callbacks autorizados
   • Status inicial: Ativo

5. Receber as credenciais

Após a criação bem-sucedida, a tela exibe:

• Client ID
• Client Secret

⚠️

Importante: Copie e armazene o client_secret em local seguro. Essa credencial será necessária para o fluxo OAuth da aplicação cliente e não poderá ser recuperada posteriormente.

6. Consultar exemplos de URL de autorização

A Soft CS gera automaticamente exemplos de URL de autorização baseados em:

• client_id
• Escopos selecionados
• Cada redirect_uri cadastrado

Cada callback gera um exemplo correspondente, incluindo os parâmetros principais:

• client_id
• redirect_uri
• response_type=code
• scope
• state
• code_challenge
• code_challenge_method=S256

Nota: A Soft CS exige PKCE. Os valores de state e code_challenge mostrados são ilustrativos e devem ser gerados pela aplicação cliente em cada requisição.

7. Gerenciar a aplicação após criação

A aplicação criada passa a aparecer na listagem de Aplicações API. A partir daí, você pode:

• Editar nome, descrição, callbacks e escopos
• Ativar ou desativar a aplicação
• Copiar o Client ID
• Excluir a aplicação
• Visualizar as credenciais
• Regenerar o Client Secret

Ao regenerar o secret:

• O valor anterior é invalidado imediatamente
• Integrações externas precisam ser atualizadas com o novo secret

8. Fluxo completo

Menu lateral > Configurações > API
    ↓
Aplicações API
    ↓
Nova aplicação
    ↓
Preencher: nome, descrição, callbacks e escopos
    ↓
Salvar
    ↓
Copiar Client ID e Client Secret
    ↓
Usar URL de autorização para iniciar integração OAuth