Centro de ayudaIntegraciones

Para: Administradores

Autenticar las solicitudes de API con una clave.

Envía tu clave como token de portador a la API del panel de administración para obtener una clave de gestión o a la API del portal para obtener una clave central, y limita su uso a tus direcciones IP.

En este artículo5 secciones

Antes de empezar

Esta página explica dónde enviar cada tipo de clave APILlave Un token secreto, creado en la sección de Integración, que permite que tu propio software utilice la API del hub., cómo enviarla, y por qué una clave puede ser rechazada.

Direcciones

LlaveDirección baseEjemplo
Gestionar los aspectos clave.https://prd-api-manage.caseactive.com/v1/<hub id>/https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases
Gestionar las importaciones clave.https://prd-api-manage.caseactive.com/v1/integration/<hub id>/https://prd-api-manage.caseactive.com/v1/integration/ca-7e6d5c4b3a2f10/imports
Tecla de accesohttps://prd-api-app.caseactive.com/v1/<hub id>/https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases
Llave de Hub, un casohttps://prd-api-app.caseactive.com/v1/<hub id>/<case id>/https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts

Su ID de hub es ca- Y también 14 caracteres. Se muestra como… Identificación del centro Sobre ello. Descripción general En cualquier caso de su portal, hay un botón para copiar la información relacionada con ese caso. El identificador del caso es… cc- Y 14 caracteres, que se muestran allí como Identificación del caso.

Enviar la clave

Envíe la clave en el encabezado Authorization de cada llamada, después de Bearer y un espacio.

curl https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/roles \
  -H "Authorization: Bearer YOUR_API_KEY"
  • Envíe cuerpos JSON con Content-Type: application/json.
  • Un clave no caduca. Funciona hasta que un administrador la desactiva o la elimina en la sección Integración › Claves.
  • Todos los códigos de llamada deben ser rellenados desde cero: no hay ninguna sesión o token que se pueda intercambiar.
  • Las fechas y los horarios se indican en UTC.

Limitar dónde se utiliza

Bajo Fuente CIDR, se puede limitar la clave a la dirección IPv4 pública de su sistema, como 203.0.113.10, o a un rango de direcciones, como 203.0.113.0/24. La API solo acepta conexiones IPv4; por lo tanto, se rechaza la solicitud cuando se intenta utilizar una dirección o rango IPv6. También se rechaza cualquier solicitud proveniente de cualquier otro lugar, y se devuelve el código 401 junto con el mensaje LoginSourceIpException. Para cambiar el rango, consulte Restringir o revocar una clave de API.

Cuando se rechaza una llave

Cada rechazo se convierte en un cuerpo de error, cuyos nombres son message. Para más información, vea Manera de manejar los errores de la API y los códigos de estado.

EstadomessagePor qué¿Qué hacer?
401UnauthorizedNo se envió ninguna clave. O, en caso contrario, lo que se envió no es una clave.Verifique el encabezado Authorization.
401HostNotFoundExceptionLa identificación del centro de comunicaciones en la dirección no existe.Copie Identificación del centro una vez más.
401HostPurgingExceptionEl nodo está siendo eliminado.Pídale a un administrador de su centro de datos que lo ayude.
401SessionNotFoundExceptionLa clave fue eliminada, o pertenece a otro centro de procesamiento.Utilice una llave actualizada para este hub.
401LoginKeyInactiveExceptionLa llave está apagada.Pídale a un administrador que lo active.
401LoginKeyWrongApiExceptionSe envió una clave de administración a la dirección de la clave del centro de control, o al revés.Utilice la dirección correspondiente al tipo de clave.
401LoginSourceIpExceptionLa llamada provenía de fuera del rango de alcance de la llave.Llame desde una dirección permitida, o amplíe el rango de direcciones a las que se puede llamar.
401LoginSourceCidrExceptionEl rango de datos en el que se guarda la clave no puede ser leído.Correcto Fuente CIDR
403BotNotAllowedExceptionUna clave de administración que utiliza algo que no puede manejar.Véase “Comprenda qué puede hacer la API”.
403ManageBillingInactiveExceptionEl panel de administración de tu centro de datos está bloqueado después de un pago fallido. Solo se puede administrar la clave correspondiente.Pídale a un administrador que actualice el método de pago.
403BillingReadOnlyExceptionLa suscripción de tu centro de control ha expirado, y su portal es de solo lectura. Por lo tanto, una clave de centro de control puede leer los datos, pero no puede cambiar nada.Pídale a un administrador que reinicie la suscripción.
403CaseClosedExceptionUna llave de conexión intentó cambiar un caso cerrado.Primero, abra el caso nuevamente.
404CaseNotFoundExceptionSe ha utilizado una clave de “hub” para referirse a un caso que no existe, o que no se encuentra en el “hub” correspondiente.Verifique el identificador del caso.
503LoginSessionExceptionEl centro de control estaba demasiado ocupado como para poder verificar la clave.Intente de nuevo en breve.

Un 401 siempre significa que la llave en sí fue rechazada. Por lo tanto, la sincronización puede detenerse y alertar a alguien. Otros errores se refieren a los aspectos relacionados con la llamada.

Artículos relacionados

Gestionar errores de API y códigos de estadoLea el cuerpo del error, qué significan los códigos 400, 401, 403, 404, 500 y 503, y por qué un elemento que su clave no puede ver responde con el código 404.IntegracionesEntienda lo que la API puede hacerDescubre qué funciones pueden alcanzar una clave de administración y una clave de concentrador, por qué cada clave actúa como asistente virtual y dónde encontrar la lista técnica completa.IntegracionesRestringir o revocar una clave APILimite una clave a determinadas direcciones IP, desactívela o elimínela, y vea cuándo se utilizó por última vez.Integraciones · 2 min