
Idioma 🇪🇸 Español
Primeros pasos
Documentación
Referencia de API
Agregación
Registros de auditoría
Bloquear desde comentario
Comprobar comentarios bloqueados
Comentarios
Configuraciones de dominio
Plantillas de correo
Registro de eventos
Publicaciones del feed
Marcar comentario
Etiquetas (hashtags)
Moderadores
Contador de notificaciones
Notificaciones
Páginas
Eventos webhook pendientes
Configuraciones de preguntas
Resultados de preguntas
Agregación de resultados de preguntas
Usuarios SSO
Suscripciones
Uso diario del inquilino
Paquetes de inquilino
Usuarios del inquilino
Inquilinos
Subir imagen
Progreso de insignias de usuario
Insignias de usuario
Notificaciones de usuario
Estados de presencia de usuario
Búsqueda de usuarios
Usuarios
Votos
FastComments Swift SDK
Este es el SDK oficial de Swift para FastComments.
SDK oficial de Swift para la API de FastComments
Repositorio
Instalación 
Swift Package Manager
Agregue lo siguiente a su archivo Package.swift:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "0.0.1")
]
O en Xcode:
- Archivo > Añadir paquetes...
- Ingrese la URL del repositorio:
https://github.com/fastcomments/fastcomments-swift.git - Seleccione la versión que desea usar
Requisitos
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Contenido de la Biblioteca 
El SDK de FastComments para Swift consta de varios módulos:
Módulo del cliente - Cliente de API generado automáticamente para las APIs REST de FastComments
- Definiciones completas de tipos para todos los modelos de la API
- Endpoints tanto autenticados (
DefaultAPI) como públicos (PublicAPI) - Soporte completo para async/await
- Consulte client/README.md para obtener documentación detallada de la API
Módulo SSO - Utilidades de inicio de sesión único (Single Sign-On) del lado del servidor
- Generación segura de tokens para la autenticación de usuarios
- Soporte tanto para modos SSO simples como seguros
- Firmado de tokens basado en HMAC-SHA256 usando CryptoKit
Inicio rápido 
Uso de la API Pública
import FastCommentsSwift
// Crear cliente de la API
let publicApi = PublicAPI()
// Obtener comentarios para una página
do {
let response = try await publicApi.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
Uso de la API Autenticada
import FastCommentsSwift
// Crear configuración con la clave API
let defaultApi = DefaultAPI()
defaultApi.apiKey = "your-api-key"
// Obtener comentarios usando la API autenticada
do {
let response = try await defaultApi.getComments(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
Uso de SSO para la autenticación
SSO seguro (recomendado para producción)
import FastCommentsSwift
let apiKey = "your-api-key"
// Crear datos de usuario SSO seguros (¡solo del lado del servidor!)
let userData = SecureSSOUserData(
id: "user-123", // ID de usuario
email: "user@example.com", // Correo electrónico
username: "johndoe", // Nombre de usuario
avatar: "https://example.com/avatar.jpg" // URL del avatar
)
// Generar token SSO
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Pase este token a su frontend para la autenticación
} catch {
print("Error creating SSO token: \(error)")
}
SSO simple (para desarrollo/pruebas)
import FastCommentsSwift
// Crear datos de usuario SSO simples (no se necesita clave API)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Generar token SSO simple
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
APIs públicas vs seguras 
El SDK de FastComments proporciona dos tipos de endpoints de API:
PublicAPI - Client-Safe Endpoints
The PublicAPI contains endpoints that are safe to call from client-side code (iOS/macOS apps). These endpoints:
- No requieren una API key
- Pueden usar SSO tokens para la autenticación
- Están sujetas a límites de tasa por usuario/dispositivo
- Son adecuados para aplicaciones orientadas al usuario final
Ejemplo de uso: Recuperar y crear comentarios en tu app iOS
DefaultAPI - Server-Side Endpoints
The DefaultAPI contains authenticated endpoints that require an API key. These endpoints:
- Requieren tu API key de FastComments
- DEBEN llamarse SÓLO desde código del lado del servidor
- Proporcionan acceso completo a tus datos de FastComments
- Están sujetas a límites de tasa por tenant
Ejemplo de uso: Operaciones administrativas, exportación masiva de datos, herramientas de moderación
IMPORTANTE: Nunca expongas tu API key en código del lado del cliente. Las API keys sólo deben usarse del lado del servidor.
Realizar llamadas a la API 
El SDK de Swift utiliza la sintaxis moderna async/await para todas las llamadas a la API:
let response = try await publicApi.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Problemas comunes 
Errores 401 No autorizados
Si estás recibiendo errores 401 al usar la API autenticada:
- Comprueba tu API key: Asegúrate de que estás usando la API key correcta en el panel de control de FastComments
- Verifica el tenant ID: Asegúrate de que el tenant ID coincide con tu cuenta
- Formato de la API key: La API key debe establecerse en el cliente de la API:
let defaultApi = DefaultAPI()
defaultApi.apiKey = "YOUR_API_KEY"
- Usando la API equivocada: Asegúrate de usar
DefaultAPI(noPublicAPI) para llamadas autenticadas
Problemas con tokens SSO
Si los tokens SSO no funcionan:
- Usa el modo seguro en producción: Siempre usa
FastCommentsSSO.createSecure()con tu API key para producción - Solo del lado del servidor: Genera tokens SSO seguros en tu servidor, nunca expongas tu API key a los clientes
- Verifica los datos del usuario: Asegúrate de que se proporcionan todos los campos obligatorios (id, email, username)
- Expiración del token: Los tokens SSO seguros incluyen una marca de tiempo y pueden expirar. Genera tokens nuevos según sea necesario.
Errores SSL/TLS
Si encuentras errores SSL/TLS:
- Asegúrate de que el Info.plist de tu app permita conexiones HTTPS a fastcomments.com
- Verifica que no estés usando excepciones de App Transport Security que puedan bloquear la conexión
Notas 
IDs de transmisión
Verás que debes pasar un broadcastId en algunas llamadas a la API. Cuando recibas eventos, obtendrás este ID de vuelta, de modo que sabrás ignorar el evento si planeas aplicar cambios de forma optimista en el cliente (lo cual probablemente querrás hacer, ya que ofrece la mejor experiencia). Pasa un UUID aquí. El ID debe ser lo suficientemente único para no repetirse en una sesión.
let broadcastId = UUID().uuidString
Agregación 
Agrega documentos agrupándolos (si se proporciona groupBy) y aplicando múltiples operaciones. Se admiten diferentes operaciones (p. ej., sum, countDistinct, avg, etc.).
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Respuesta
Devuelve: AggregationResponse
Ejemplo

Obtener registros de auditoría 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Respuesta
Devuelve: GetAuditLogs200Response
Ejemplo

Bloquear desde comentario público 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: BlockFromCommentPublic200Response
Ejemplo

Desbloquear comentario público 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: UnBlockCommentPublic200Response
Ejemplo

Comprobar comentarios bloqueados 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentIds | string | query | Sí | Una lista separada por comas de identificadores de comentarios. |
| sso | string | query | No |
Respuesta
Devuelve: CheckedCommentsForBlocked200Response
Ejemplo

Bloquear usuario desde comentario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: BlockFromCommentPublic200Response
Ejemplo

Crear comentario público 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| broadcastId | string | query | Sí | |
| sessionId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: CreateCommentPublic200Response
Ejemplo

Eliminar comentario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Respuesta
Devuelve: DeleteComment200Response
Ejemplo

Eliminar comentario público 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| editKey | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: DeleteCommentPublic200Response
Ejemplo

Eliminar voto de comentario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: DeleteCommentVote200Response
Ejemplo

Marcar comentario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: FlagComment200Response
Ejemplo

Obtener comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetComment200Response
Ejemplo

Obtener comentarios 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | integer | query | No | |
| limit | integer | query | No | |
| skip | integer | query | No | |
| asTree | boolean | query | No | |
| skipChildren | integer | query | No | |
| limitChildren | integer | query | No | |
| maxTreeDepth | integer | query | No | |
| urlId | string | query | No | |
| userId | string | query | No | |
| anonUserId | string | query | No | |
| contextUserId | string | query | No | |
| hashTag | string | query | No | |
| parentId | string | query | No | |
| direction | string | query | No |
Respuesta
Devuelve: GetComments200Response
Ejemplo

Obtener comentarios públicos 
req tenantId urlId
Parámetros
| Name | Type | Location | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No |
Respuesta
Devuelve: GetCommentsPublic200Response
Ejemplo

Obtener texto del comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| editKey | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: GetCommentText200Response
Ejemplo

Obtener nombres de usuarios de votos de comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | ruta | Sí | |
| commentId | string | ruta | Sí | |
| dir | integer | consulta | Sí | |
| sso | string | consulta | No |
Respuesta
Devuelve: GetCommentVoteUserNames200Response
Ejemplo

Bloquear comentario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: LockComment200Response
Ejemplo

Anclar comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Respuesta
Devuelve: PinComment200Response
Ejemplo

Guardar comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Respuesta
Devuelve: SaveComment200Response
Ejemplo

Guardar comentarios en bloque 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Respuesta
Devuelve: [SaveComment200Response]
Ejemplo

Establecer texto del comentario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| editKey | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: SetCommentText200Response
Ejemplo

Desbloquear usuario desde comentario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: UnBlockCommentPublic200Response
Ejemplo

Desmarcar comentario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: FlagComment200Response
Ejemplo

Desbloquear comentario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: LockComment200Response
Ejemplo

Desanclar comentario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: PinComment200Response
Ejemplo

Actualizar comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Votar comentario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| urlId | string | query | Sí | |
| broadcastId | string | query | Sí | |
| sessionId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: VoteComment200Response
Ejemplo

Agregar configuración de dominio 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: AddDomainConfig200Response
Ejemplo

Eliminar configuración de dominio 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| domain | string | path | Sí |
Respuesta
Devuelve: DeleteDomainConfig200Response
Ejemplo

Obtener configuración de dominio 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| domain | string | path | Sí |
Respuesta
Devuelve: GetDomainConfig200Response
Ejemplo

Obtener configuraciones de dominio 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: GetDomainConfigs200Response
Ejemplo

Actualizar parcialmente configuración de dominio 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| domainToUpdate | string | path | Sí |
Respuesta
Devuelve: GetDomainConfig200Response
Ejemplo

Reemplazar configuración de dominio 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| domainToUpdate | string | path | Sí |
Respuesta
Devuelve: GetDomainConfig200Response
Ejemplo

Crear plantilla de correo 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateEmailTemplate200Response
Ejemplo

Eliminar plantilla de correo 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Eliminar error de renderizado de plantilla de correo 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| errorId | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener plantilla de correo 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetEmailTemplate200Response
Ejemplo

Obtener definiciones de plantillas de correo 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: GetEmailTemplateDefinitions200Response
Ejemplo

Obtener errores de renderizado de plantilla de correo 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetEmailTemplateRenderErrors200Response
Ejemplo

Obtener plantillas de correo 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | consulta | Sí | |
| skip | number | consulta | No |
Respuesta
Devuelve: GetEmailTemplates200Response
Ejemplo

Renderizar plantilla de correo 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| locale | string | query | No |
Respuesta
Devuelve: RenderEmailTemplate200Response
Ejemplo

Actualizar plantilla de correo 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener registro de eventos 
req tenantId urlId userIdWS
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| userIdWS | string | query | Sí | |
| startTime | integer | query | Sí | |
| endTime | integer | query | Sí |
Respuesta
Devuelve: GetEventLog200Response
Ejemplo

Obtener registro global de eventos 
req tenantId urlId userIdWS
Parámetros
| Name | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| userIdWS | string | query | Sí | |
| startTime | integer | query | Sí | |
| endTime | integer | query | Sí |
Respuesta
Devuelve: GetEventLog200Response
Ejemplo

Crear publicación del feed 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Respuesta
Devuelve: CreateFeedPost200Response
Ejemplo

Crear publicación del feed pública 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: CreateFeedPostPublic200Response
Ejemplo

Eliminar publicación del feed pública 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postId | string | path | Sí | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: DeleteFeedPostPublic200Response
Ejemplo

Obtener publicaciones del feed 
req tenantId afterId
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
Respuesta
Devuelve: GetFeedPosts200Response
Ejemplo

Obtener publicaciones del feed públicas 
req tenantId afterId
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No | |
| sso | string | query | No | |
| isCrawler | boolean | query | No | |
| includeUserInfo | boolean | query | No |
Respuesta
Devuelve: GetFeedPostsPublic200Response
Ejemplo

Obtener estadísticas de publicaciones del feed 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postIds | array | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: GetFeedPostsStats200Response
Ejemplo

Obtener reacciones de usuario públicas 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postIds | array | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: GetUserReactsPublic200Response
Ejemplo

Reaccionar a publicación del feed pública 
Parámetros
| Nombre | Type | Location | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postId | string | path | Sí | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: ReactFeedPostPublic200Response
Ejemplo

Actualizar publicación del feed 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Actualizar publicación del feed pública 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postId | string | path | Sí | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: CreateFeedPostPublic200Response
Ejemplo

Marcar comentario público 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| isFlagged | boolean | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Agregar etiqueta (hashtag) 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | No |
Respuesta
Devuelve: AddHashTag200Response
Ejemplo

Agregar hashtags en bloque 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | No |
Respuesta
Devuelve: AddHashTagsBulk200Response
Ejemplo

Eliminar hashtag 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tag | string | path | Sí | |
| tenantId | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener hashtags 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| page | number | query | No |
Respuesta
Devuelve: GetHashTags200Response
Ejemplo

Actualizar parcialmente hashtag 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Sí | |
| tenantId | string | query | No |
Respuesta
Devuelve: PatchHashTag200Response
Ejemplo

Crear moderador 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateModerator200Response
Ejemplo

Eliminar moderador 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| sendEmail | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener moderador 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetModerator200Response
Ejemplo

Obtener moderadores 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetModerators200Response
Ejemplo

Enviar invitación 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| fromName | string | query | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Actualizar moderador 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Eliminar contador de notificaciones 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener contador de notificaciones en caché 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetCachedNotificationCount200Response
Ejemplo

Obtener contador de notificaciones 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Respuesta
Devuelve: GetNotificationCount200Response
Ejemplo

Obtener notificaciones 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
Response
Devuelve: GetNotifications200Response
Ejemplo

Actualizar notificación 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Agregar página 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: AddPageAPIResponse
Ejemplo

Eliminar página 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: DeletePageAPIResponse
Ejemplo

Obtener página por ID de URL 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | Sí |
Respuesta
Devuelve: GetPageByURLIdAPIResponse
Ejemplo

Obtener páginas 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: GetPagesAPIResponse
Ejemplo

Actualizar parcialmente página 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respuesta
Devuelve: PatchPageAPIResponse
Ejemplo

Eliminar evento webhook pendiente 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener contador de eventos webhook pendientes 
Parámetros
| Name | Type | Location | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No |
Respuesta
Devuelve: GetPendingWebhookEventCount200Response
Ejemplo

Obtener eventos webhook pendientes 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetPendingWebhookEvents200Response
Ejemplo

Crear configuración de pregunta 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateQuestionConfig200Response
Ejemplo

Eliminar configuración de pregunta 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener configuración de pregunta 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetQuestionConfig200Response
Ejemplo

Obtener configuraciones de preguntas 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetQuestionConfigs200Response
Ejemplo

Actualizar configuración de pregunta 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Crear resultado de pregunta 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateQuestionResult200Response
Ejemplo

Eliminar resultado de pregunta 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener resultado de pregunta 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetQuestionResult200Response
Ejemplo

Obtener resultados de preguntas 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | No | |
| userId | string | query | No | |
| startDate | string | query | No | |
| questionId | string | query | No | |
| questionIds | string | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetQuestionResults200Response
Ejemplo

Actualizar resultado de pregunta 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Agregación de resultados de preguntas 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
Respuesta
Devuelve: AggregateQuestionResults200Response
Ejemplo

Agregación masiva de resultados de preguntas 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| forceRecalculate | boolean | query | No |
Respuesta
Devuelve: BulkAggregateQuestionResults200Response
Ejemplo

Combinar comentarios con resultados de preguntas 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Respuesta
Devuelve: CombineCommentsWithQuestionResults200Response
Ejemplo

Agregar usuario SSO 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: AddSSOUserAPIResponse
Ejemplo

Eliminar usuario SSO 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
Respuesta
Devuelve: DeleteSSOUserAPIResponse
Ejemplo

Obtener usuario SSO por correo electrónico 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| string | path | Sí |
Respuesta
Devuelve: GetSSOUserByEmailAPIResponse
Ejemplo

Obtener usuario SSO por ID 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetSSOUserByIdAPIResponse
Ejemplo

Obtener usuarios SSO 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | integer | query | No |
Respuesta
Devuelve: GetSSOUsers200Response
Ejemplo

Actualizar parcialmente usuario SSO 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| updateComments | boolean | query | No |
Respuesta
Devuelve: PatchSSOUserAPIResponse
Ejemplo

Reemplazar usuario SSO 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| updateComments | boolean | query | No |
Respuesta
Devuelve: PutSSOUserAPIResponse
Ejemplo

Crear suscripción 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateSubscriptionAPIResponse
Ejemplo

Eliminar suscripción 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No |
Respuesta
Devuelve: DeleteSubscriptionAPIResponse
Ejemplo

Obtener suscripciones 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No |
Respuesta
Devuelve: GetSubscriptionsAPIResponse
Ejemplo

Obtener usos diarios del inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetTenantDailyUsages200Response
Ejemplo

Crear paquete de inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateTenantPackage200Response
Ejemplo

Eliminar paquete de inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener paquete de inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetTenantPackage200Response
Ejemplo

Obtener paquetes de inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetTenantPackages200Response
Ejemplo

Reemplazar paquete de inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Actualizar paquete de inquilino 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Response
Devuelve: FlagCommentPublic200Response
Ejemplo

Crear usuario del inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateTenantUser200Response
Ejemplo

Eliminar usuario del inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener usuario del inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetTenantUser200Response
Ejemplo

Obtener usuarios del inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetTenantUsers200Response
Ejemplo

Reemplazar usuario del inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| updateComments | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Enviar enlace de inicio de sesión 
Parámetros
| Name | Type | Location | Requerido | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| redirectURL | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Actualizar usuario del inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| updateComments | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Crear inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateTenant200Response
Ejemplo

Eliminar inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| sure | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetTenant200Response
Ejemplo

Obtener inquilinos 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| meta | string | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetTenants200Response
Ejemplo

Actualizar inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Subir imagen 
Subir y redimensionar una imagen
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Preajuste de tamaño: "Default" (1000x1000px) o "CrossPlatform" (crea tamaños para dispositivos populares) |
| urlId | string | query | No | Id de página desde la cual se realiza la subida, para configurar |
Respuesta
Devuelve: UploadImageResponse
Ejemplo

Obtener progreso de insignia de usuario por ID 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetUserBadgeProgressById200Response
Ejemplo

Obtener progreso de insignia por ID de usuario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | path | Sí |
Respuesta
Devuelve: GetUserBadgeProgressById200Response
Ejemplo

Obtener lista de progreso de insignias de usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetUserBadgeProgressList200Response
Ejemplo

Crear insignia de usuario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateUserBadge200Response
Ejemplo

Eliminar insignia de usuario 
Parámetros
| Nombre | Tipo | Location | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: UpdateUserBadge200Response
Ejemplo

Obtener insignia de usuario 
Parámetros
| Nombre | Tipo | Location | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetUserBadge200Response
Ejemplo

Obtener insignias de usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetUserBadges200Response
Ejemplo

Actualizar insignia de usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: UpdateUserBadge200Response
Ejemplo

Obtener contador de notificaciones de usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: GetUserNotificationCount200Response
Ejemplo

Obtener notificaciones de usuario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: GetUserNotifications200Response
Ejemplo

Restablecer contador de notificaciones de usuario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: ResetUserNotifications200Response
Ejemplo

Restablecer notificaciones de usuario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: ResetUserNotifications200Response
Ejemplo

Actualizar estado de suscripción a notificaciones de comentarios de usuario 
Habilitar o deshabilitar notificaciones para un comentario específico.
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| notificationId | string | path | Sí | |
| optedInOrOut | string | path | Sí | |
| commentId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: UpdateUserNotificationStatus200Response
Ejemplo

Actualizar estado de suscripción a notificaciones de página de usuario 
Habilita o deshabilita las notificaciones para una página. Cuando los usuarios están suscritos a una página, se crean notificaciones para nuevos comentarios raíz, y también
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | Sí | |
| url | string | query | Sí | |
| pageTitle | string | query | Sí | |
| subscribedOrUnsubscribed | string | path | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: UpdateUserNotificationStatus200Response
Ejemplo

Actualizar estado de notificación de usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| notificationId | string | path | Sí | |
| newStatus | string | path | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: UpdateUserNotificationStatus200Response
Ejemplo

Obtener estados de presencia de usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlIdWS | string | query | Sí | |
| userIds | string | query | Sí |
Respuesta
Devuelve: GetUserPresenceStatuses200Response
Ejemplo

Buscar usuarios 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| usernameStartsWith | string | query | Sí | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: SearchUsers200Response
Ejemplo

Obtener usuario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetUser200Response
Ejemplo

Crear voto 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | query | Sí | |
| direction | string | query | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: VoteComment200Response
Ejemplo

Eliminar voto 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| editKey | string | query | No |
Respuesta
Devuelve: DeleteCommentVote200Response
Ejemplo

Obtener votos 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | Sí |
Respuesta
Devuelve: GetVotes200Response
Ejemplo

Obtener votos para usuario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: GetVotesForUser200Response
Ejemplo

¿Necesitas ayuda?
Si encuentras algún problema o tienes preguntas sobre el SDK de Swift, por favor:
Contribuciones
¡Las contribuciones son bienvenidas! Por favor visita el repositorio de GitHub para las directrices de contribución.