Para: Administradores
Entenda o que a API pode fazer.
Saiba o que uma chave de gerenciamento e uma chave central podem fazer, por que cada chave funciona como um Assistente Virtual e onde encontrar a lista completa de especificações técnicas.
Neste artigo2 seções
A API permite que seu próprio software, como um sistema de gerenciamento de casos, funcione em conjunto com o seu hub, sem que ninguém precise usar as telas do sistema. Essa API é chamada por meio de uma chave da APIChave Um token secreto, criado em Integração, que permite que seu próprio software use a API do hub.. Existem dois tipos de chaves: uma chave para o funcionamento do painel administrativo, relacionada a casos e pessoas; e outra chave para o funcionamento dentro dos próprios casos.
Como funciona
Duas chaves, duas APIs. Cada tipo de chave corresponde a um endereço específico. Em seguida, vem o ID do seu hub. Esses endereços são rejeitados pelo outro dispositivo.
| Chave | Endereço | O que isso abrange |
|---|---|---|
| Gerencie os elementos chave. | https://prd-api-manage.caseactive.com/v1/<hub id>/ | Casos de uso, quem está envolvido, pessoas e seus acessos, funções, etapas do processo, busca de informações e faturas para leitura. As importações estão em https://prd-api-manage.caseactive.com/v1/integration/<hub id>/. |
| Chave de Hub | https://prd-api-app.caseactive.com/v1/<hub id>/ | Tudo o que está dentro de cada caso: postagens e comentários, arquivos, formulários, documentos eletrônicos, tarefas, faturas, eventos, notas e os detalhes do caso. |
Que funções incríveis uma chave de gerenciamento pode ter! Apenas esses. Qualquer outro chamado no API do painel administrativo resultará em uma resposta 403. BotNotAllowedException.
- Casos: listar, criar, ler, atualizar e excluir. Veja Criar e atualizar casos com um gerenciamento de chaves.
- Membros do caso: lista, adição e remoção. Veja Como adicionar e remover membros do caso, utilizando a chave “manage”.
- Pessoas: listar, adicionar, ler e desativar/reativar as informações sobre as pessoas. Veja Como adicionar e atualizar usuários com uma chave de gerenciamento.
- Papéis e etapas: leia o conteúdo correspondente. Veja Os papéis de leitura, com a chave “manage”.
- Campos personalizados: leia as páginas de campo do seu caso e do usuário. Veja Criar e atualizar casos com um gerenciamento de chaves.
- Faturas: leia-as. Veja Como ler faturas com um gerenciador de faturas.
- Pesquise. Veja Pesquisar casos e usuários com chave de gerenciamento.
- Importações. Veja “Executar uma importação com a chave ‘manage’”.
Cada chave é o seu Assistente Virtual. Sinais importantes enquanto você está no seu centro de controle. Assistente VirtualAssistente Virtual Um membro de equipe automatizado que publica mensagens de boas-vindas, atualizações e posts de apresentação para a empresa; suas publicações exibem um selo de Assistente Virtual.. O que é postado é indicado sob o nome e o emblema da Assistente Virtual. As alterações feitas são registradas como sendo do próprio Assistente Virtual. A Assistente Virtual está presente em todos os casos, então uma chave de hub permite acesso a todos os casos no seu hub. Ela pode fazer tudo o que a função da Assistente Virtual permite; por padrão, isso é algo que o pessoal pode fazer. No entanto, um caso fechado só pode ser lido pela Assistente Virtual. Uma chave de hub não pode criar casos, adicionar ou remover pessoas, pagar faturas, ou responder a consultas.
As chaves não expiram. As informações importantes continuarão disponíveis até que um administrador as desative ou as apague. Limite o número de informações por sistema à própria endereço IPv4 público do sistema. Veja mais detalhes aqui. Restringir ou revogar uma chave de API.
As páginas técnicas. Cada API publica uma lista técnica completa de suas chamadas, sem a necessidade de login.
| Gerenciar chave | Chave do hub | |
|---|---|---|
| Interativo (Swagger UI) | https://prd-api-manage.caseactive.com/ | https://prd-api-app.caseactive.com/ |
| Referência (ReDoc) | https://prd-api-manage.caseactive.com/redoc | https://prd-api-app.caseactive.com/redoc |
| Documento OpenAPI | https://prd-api-manage.caseactive.com/openapi.json | https://prd-api-app.caseactive.com/openapi.json |
As aplicações listam todas as chamadas que realizam, incluindo muitas das quais o teclado de gestos não consegue identificar. A lista acima indica quais funções o teclado de gestos pode utilizar. Para tentar realizar uma chamada na página interativa, selecione Autorizar e cole sua chave de acesso.
Um hub bloqueado. Quando o painel de administração do seu hub é bloqueado após um pagamento falhado, uma chave de gerenciamento é rejeitada com o código 403 ManageBillingInactiveException. Uma chave de hub continua funcionando até que o portal se torne de acesso somente leitor: 14 dias após o pagamento falho, caso ainda não tenha sido pago, ou no dia em que a assinatura cancelada termina. A partir daí, a chave de hub ainda pode ser usada para realizar alterações, mas todas as mudanças são rejeitadas com o código 403 BillingReadOnlyException, até que o administrador reinicie a assinatura.
Quando usar
Use uma chave de gerenciamento para manter seu hub sincronizado com outro sistema: crie casos, adicione clientes e coloque-os nesses casos. Tire o acesso das pessoas quando elas saírem, ou carregue várias informações de uma vez, a partir de um arquivo. Use também uma chave de hub para trabalhar dentro dos casos, com seu próprio software – por exemplo, para adicionar informações quando algo muda no sistema.
Para saber sobre as mudanças que ocorrem no seu hub, e não apenas pedir por elas, utilize um webhook. Para isso, consulte Criar um webhook. Para criar uma chave, veja Criar uma chave de API.