Esta guía le mostrará cómo integrar Talkdesk Knowledge Management con prácticamente cualquier plataforma mediante el uso de nuestra API de Knowledge Management. En el artículo, encontrará los pasos esenciales para llevar a cabo este proceso, incluida la generación de credenciales, la creación de un conector y la gestión de contenidos.
Generación de credenciales
Antes de acceder a la API, debe generar credenciales a través de la interfaz de usuario mediante Talkdesk Builder:
En Talkdesk Builder, vaya a OAuth Clients [1] y seleccione New OAuth Client [2].
Asigne un nombre de cliente [3] y seleccione “Client credentials” [4] y “Refresh token” [5]. Asegúrese de añadir los campos km-external-sources:read y km-external-sources:write [6].
Haga clic en Descargar [7] para obtener el archivo OAuth. Este archivo JSON contiene todos los datos del cliente necesarios para la autenticación.
Cómo crear el conector
Con sus credenciales listas, ya puede crear un conector para interactuar con la API. Tiene dos opciones: a través de la interfaz de usuario (UI, por sus siglas en inglés) o directamente a través de la API.
Cómo usar la interfaz de usuario
Siga los procedimientos estándar para crear un nuevo conector en Knowledge Management y seleccione Custom API.
En la API
- Para crear un conector externo mediante la API, consulte nuestra exhaustiva documentación Crear fuente externa para acceder a instrucciones detalladas.
- Para gestionar y actualizar un conector externo existente, consulte la guíaActualizar fuente externa.
- Para obtener información sobre el conector externo existente, lea la documentación Obtener fuente externa.
- Si tiene que buscar a través de su conector externo, consulte la documentaciónBuscar fuentes externas.
- Para eliminar un conector externo, consulte nuestras instrucciones Eliminar fuente externa.
Gestión de contenido
Una vez configurado el conector y generadas las credenciales, podrá gestionar el contenido mediante el envío, la edición y la eliminación de documentos. Estas acciones solo están disponibles a través de la API.
Creación/actualización de contenido
Utilice el mismo procedimiento para crear o actualizar contenido. Si ya existe un ID de documento, se actualizará el contenido; en caso contrario, se creará. Los ID de los documentos debe gestionarlos el cliente, y cada documento debe corresponder a un ID. Siga los procedimientos que se indican en nuestra documentación de la API del documento Upsert.
Eliminar contenido
Para eliminar un documento, necesitará el ID del documento. Siga los procedimientos descritos en nuestra documentación sobre la API de eliminación de documentos para conocer todos los detalles.