Ir al contenido
Sursa Developers

Referencia de la API

La API pública de Sursa: 222 endpoints en 35 secciones. Versión 1.62.0.

La API pública de Sursa para las integraciones que se autentican con una clave de API. Los cambios dentro de /v1 son aditivos: pueden aparecer operaciones nuevas, parámetros opcionales, campos de respuesta y valores de enumeración en las respuestas, y los clientes existentes siguen funcionando. Considere válidos los valores de enumeración desconocidos en las respuestas.

URL base
https://api.sursa.com
Autenticación
Envíe una clave de API en el encabezado Authorization: Authorization: Bearer <clave>.

Secciones

health1 endpoint

Estado y versión del servicio

auth1 endpoint

Inicio de sesión, sesiones, modo «View as», cambio y restablecimiento de la contraseña, aceptación de invitaciones

users5 endpoints

Cuentas de usuario de la organización

api-keys9 endpoints

Claves de API de la organización

apps8 endpoints

Aplicaciones OAuth de la organización y autorizaciones de los empleados

oauth3 endpoints

El protocolo OAuth 2.0: pantalla de consentimiento, emisión y revocación de tokens, metadatos del servidor de autorización

audit4 endpoints

Registro de auditoría de la organización

org1 endpoint

La organización, su logotipo y la exportación de datos

categories4 endpoints

Categorías de documentos

collections6 endpoints

Colecciones de conocimiento

cards26 endpoints

Tarjetas de conocimiento: subida, contenido, tablas, versiones, verificación, comentarios

jobs5 endpoints

Cola de indexación: trabajos, vista previa del análisis, flujo de cambios (SSE)

conversations2 endpoints

Conversaciones con el asistente

answers3 endpoints

Búsqueda y respuestas del asistente, incluido el flujo SSE

access-requests4 endpoints

Solicitudes de acceso a las fuentes de una respuesta oculta

questions10 endpoints

Registro de preguntas, sugerencias, exportaciones de respuestas, respuesta dinámica

files8 endpoints

Archivos de exportación

insights1 endpoint

Análisis del conocimiento: resumen, duplicados, vacíos de conocimiento y salud del conocimiento

tasks1 endpoint

Tareas de un usuario y de un equipo

sources19 endpoints

Fuentes de datos, como Google Drive y Confluence

permissions17 endpoints

Modelo de acceso: el registro de permisos y los permisos sobre la organización, las colecciones, las tarjetas y las fuentes, tanto concedidos directamente como heredados

roles4 endpoints

Roles: conjuntos de permisos con nombre, integrados y personalizados

groups7 endpoints

Grupos de usuarios: grupos normales, «All members», grupos de rol y grupos personales

folders7 endpoints

Carpetas de las colecciones: un árbol de hasta tres niveles de profundidad, orden relativo a un elemento hermano, una tarjeta en varias carpetas, permisos heredados

catalog6 endpoints

Catálogo de servicios externos (SaaS y proveedores) con nombres, sitios web, categorías, iconos y descripciones, y vínculos entre los nombres de su organización y los elementos del catálogo

drafts6 endpoints

Borradores y aprobación de la publicación

verification9 endpoints

Verificación: estado, fechas límite, verificadores, historial, la cola «Verify first», «Trust Score» y bajas

announcements5 endpoints

Avisos de lectura obligatoria: destinatarios, confirmación de lectura, informes, recordatorios, exportación

comments4 endpoints

Comentarios de las tarjetas en hilos, con ancla y estado, y reacciones

webhooks17 endpoints

Webhooks de la organización: registro de webhooks, suscripciones a eventos, firmas, entregas y reintentos

public-api1 endpoint

API pública para integraciones: la especificación legible por máquina de esta API

uploads5 endpoints

Subidas por partes de archivos grandes: la sesión, las partes, la finalización con comprobaciones y el uso en una tarjeta, un archivo comprimido o una importación

analytics4 endpoints

Analíticas del producto: eventos de uso, contadores por objeto, los paneles de salud, de uso y de contribución, el informe de renovación y las exportaciones

quality3 endpoints

Calidad de las respuestas: preguntas sin una buena respuesta y los vacíos de conocimiento en los que se está trabajando

finance6 endpoints

Documentos financieros: tipos de cambio y el directorio de contrapartes

Objetos