API Opa! Suite
Introdução
A API Opa! Suite permite a integração e manipulação de dados da plataforma Opa! Suite por meio de solicitações autenticadas. Esta documentação detalha o processo de geração e utilização de tokens de acesso para a API.
Token de Acesso
Definição
Um token de acesso é um método de autenticação essencial para operar a API do Opa! Suite. Ele funciona como uma chave digital que garante a segurança na transferência de dados.
Função
- Fornece segurança na transferência de dados
- Garante que dados sejam fornecidos apenas a solicitantes autenticados
- Limita o acesso dos desenvolvedores apenas aos dados necessários para suas aplicações
Segurança
O token de acesso funciona como uma senha, permitindo acesso controlado e seguro à API.
Processo de Geração do Token
Configuração de Perfil de Permissão
- Acesse o Menu → Configurações → Permissões
- Crie uma nova permissão do tipo API
- Defina quais dados da plataforma a API terá permissão de manipular
Configuração de Usuário
-
Navegue até Menu → Usuários
-
Opções:
- Crie um novo usuário específico para acesso API
- Edite um usuário existente para permitir acesso à API
-
No cadastro do usuário:
- Marque o parâmetro “Permitir acesso a API”
- Acesse a aba “API” que será habilitada
- Vincule o perfil de permissão criado anteriormente ao usuário
-
Clique em Salvar
Obtenção do Token
Após salvar as configurações, o token de acesso será gerado automaticamente. Copie este token para utilizá-lo nas requisições à API.
Documentação API
Para acessar nossa documentação API, acesse = https://api.opasuite.com.br/
Assuntos que podem ser realizadas através da API
- Atendimentos
- Mensagens
- Canais de comunicação
- Templates de mensagem
- Cliente
- Usuário
- Contatos
- Etiqueta
- Notificação
- Departamentos
- Motivos
- Períodos
Fluxo de Geração do Token
graph TD A[Início] --> B[Configurar Perfil de Permissão] B --> C[Criar/Editar Usuário] C --> D[Permitir Acesso à API] D --> E[Vincular Perfil de Permissão] E --> F[Salvar Configurações] F --> G[Copiar Token Gerado] G --> H[Fim]
Considerações Finais
- Mantenha o token de acesso em segurança
- Não compartilhe o token com terceiros não autorizados
- Considere a rotação periódica do token para maior segurança
Etiquetas
API TokenDeAcesso Configuracoes OpaAPI