Para: Administradores
Autenticar solicitações de API com uma chave
Envie sua chave como um token de portador para a API do Painel de Administração para obter uma chave de gerenciamento ou para a API do portal para obter uma chave de hub, e limite-a aos seus endereços IP.
Neste artigo5 seções
Antes de começar
Esta página explica para onde devem ser enviadas cada tipo de chave APIChave Um token secreto, criado em Integração, que permite que seu próprio software use a API do hub., como enviá-las, e por que uma chave é rejeitada.
Endereços
| Chave | Endereço base | Exemplo |
|---|---|---|
| Gerencie os elementos chave. | https://prd-api-manage.caseactive.com/v1/<hub id>/ | https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases |
| Gerencie as importações importantes. | https://prd-api-manage.caseactive.com/v1/integration/<hub id>/ | https://prd-api-manage.caseactive.com/v1/integration/ca-7e6d5c4b3a2f10/imports |
| Chave de Hub | https://prd-api-app.caseactive.com/v1/<hub id>/ | https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases |
| Chave de Hub, um caso | https://prd-api-app.caseactive.com/v1/<hub id>/<case id>/ | https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts |
O seu ID de hub é ca- E também 14 caracteres. Isso é mostrado como… ID do hub no… Visão geral Na página de qualquer caso no seu portal, existe um botão para copiar a informação do caso. O ID do caso é… cc- E 14 caracteres, mostrados lá como ID do caso.
Enviando a chave
Envie a chave no campo Authorization de cada chamada, após o campo Bearer e um espaço.
curl https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/roles \
-H "Authorization: Bearer YOUR_API_KEY"
- Envie corpos JSON com
Content-Type: application/json. - A chave não expira. Ela continua ativa até que um administrador a desative ou a exclua na seção Integração › Chaves.
- Todos os códigos de chamada são redefinidos: não há sessão ou token para ser trocado.
- As datas e os horários são indicados em UTC.
Limitar onde é utilizado.
Abaixo de Fonte CIDR, uma chave de acesso pode ser limitada à endereça IPv4 pública do seu sistema, como 203.0.113.10, ou a um intervalo de endereças, como 203.0.113.0/24. A API aceita apenas conexões com endereços IPv4. Portanto, endereços ou intervalos IPv6 são rejeitados ao serem salvos. Uma chamada feita de qualquer outro lugar será rejeitada com o código 401 LoginSourceIpException. Para alterar o intervalo de endereças, consulte Restringir ou revogar uma chave de acesso.
Quando uma chave é recusada
Cada recusa é considerada como um erro, e o nome message é indicado como parte desse erro. Veja Como lidar com erros de API e códigos de status.
| Status | message | Por que | O que fazer |
|---|---|---|---|
| 401 | Unauthorized | Nenhum código foi enviado, ou o que foi enviado não é um código. | Verifique o cabeçalho Authorization. |
| 401 | HostNotFoundException | O ID do hub na endereço não existe. | Copie ID do hub novamente. |
| 401 | HostPurgingException | O hub está sendo excluído. | Peça ajuda a um administrador do seu hub. |
| 401 | SessionNotFoundException | A chave foi excluída, ou pertence a outro hub. | Use a chave atual para este hub. |
| 401 | LoginKeyInactiveException | A chave está desligada. | Peça a um administrador que ative essa função. |
| 401 | LoginKeyWrongApiException | A chave de gerenciamento foi enviada para o endereço da chave do hub, ou vice-versa. | Use o endereço correspondente ao tipo de chave. |
| 401 | LoginSourceIpException | A chamada veio de fora do alcance da chave. | Ligue de um endereço permitido, ou expanda o alcance da chamada. |
| 401 | LoginSourceCidrException | O alcance onde a chave está salva não pode ser lido. | Correto Fonte CIDR |
| 403 | BotNotAllowedException | Uma chave de gerenciamento chamada algo que ela não consegue usar. | Veja Compreenda o que a API pode fazer. |
| 403 | ManageBillingInactiveException | O painel de administração do seu hub está bloqueado após um pagamento falhado. Apenas é possível gerenciar as chaves necessárias para desbloquear o painel. | Peça a um administrador que atualize o método de pagamento. |
| 403 | BillingReadOnlyException | A assinatura do seu hub expirou, e o portal dele tornou-se de acesso apenas leitor. Portanto, uma chave de hub pode ler os dados, mas não pode alterá-los. | Peça a um administrador que reinicie a assinatura. |
| 403 | CaseClosedException | A chave de hub tentou abrir um caso que estava fechado. | Primeiro, abra o caso novamente. |
| 404 | CaseNotFoundException | A chave de hub menciona um caso que não existe, ou que não está presente no seu hub. | Verifique o ID do caso. |
| 503 | LoginSessionException | O hub estava muito ocupado para que pudesse verificar a chave. | Tente novamente em breve. |
Um erro do tipo 401 significa sempre que a chave utilizada foi rejeitada. Isso pode causar uma interrupção na sincronização e, consequentemente, alertar alguém sobre o problema. Outros erros referem-se à própria chamada telefônica.