Saltar al contenido principal

​
Introducción a los endpoints para gestionar silenciados

Esta guía de inicio rápido le ayudará a realizar su primera solicitud a los endpoints para gestionar silenciados usando Postman. Si desea ver código de ejemplo en distintos lenguajes, visite nuestro repositorio de GitHub X API v2 sample code.
Requisitos previosPara completar esta guía, necesitará un conjunto de keys and tokens para autenticar su solicitud. Puede generar estas keys and tokens siguiendo estos pasos:

​
Pasos para crear una solicitud de gestión de silenciamientos

​
Paso uno: Comience con una herramienta o biblioteca

Existen varias herramientas, ejemplos de código y bibliotecas que puede usar para realizar una solicitud a este endpoint, pero aquí usaremos Postman para simplificar el proceso. Para cargar en su entorno la colección de Postman de X API v2, haga clic en el siguiente botón:
Una vez que tenga cargada en Postman la colección de X API v2, vaya a la carpeta “Mutes” y seleccione “Silenciar el id de un usuario”.  

​
Paso dos: autentica tu solicitud

Para realizar correctamente una solicitud a la X API, debes verificar que tienes permiso. Para hacerlo con este endpoint, debes autenticar tu solicitud usando OAuth 1.0a User Context o OAuth 2.0 Authorization Code with PKCE. En este ejemplo, usaremos OAuth 1.0a User Context. Debes agregar tus claves y tokens —específicamente tu API Key, API Secret Key, OAuth 1.0a user Access Token y OAuth 1.0a user Access Token Secret— en Postman. Puedes hacerlo seleccionando el entorno llamado “X API v2” en la esquina superior derecha de Postman y agregando tus claves y tokens en los campos “initial value” y “current value” (haciendo clic en el ícono del ojo junto al menú desplegable del entorno). Estas variables se incorporarán automáticamente en la pestaña de autorización de la solicitud si lo has hecho correctamente.  

​
Paso tres: Especifica quién va a silenciar a quién

Los endpoints de gestión de silencios requieren dos IDs: uno para el usuario (el usuario que desea silenciar o dejar de silenciar a otro usuario) y el usuario objetivo (el usuario que será silenciado o dejado de silenciar). El ID del usuario debe corresponder al ID del usuario autenticado, lo que significa que debes pasar los Access Tokens asociados con el ID de usuario al autenticar tu solicitud. En este caso, puedes especificar el ID que pertenece a tu propio usuario. Puedes encontrar tu ID de dos maneras:
  1. Usando el endpoint user lookup por nombre de usuario, puedes pasar un nombre de usuario y recibir el campo id.
  2. Al consultar tu Access Token, verás que la parte numérica es tu ID de usuario.  
El ID de destino puede ser cualquier ID de usuario válido. En Postman, ve a la pestaña “Params” e ingresa tu ID en la columna “Value” de la variable de ruta id. Ve a la pestaña “Body” e ingresa el ID del usuario que deseas silenciar como valor para el parámetro target_user_id. Asegúrate de no incluir espacios antes o después de ningún ID.
KeyValue
idID del usuario autenticado
target_user_idel ID del usuario que deseas silenciar

​
Paso cuatro: Haz tu solicitud y revisa tu respuesta

Una vez que esté todo configurado, haz clic en el botón “Send” y recibirás una respuesta similar al siguiente ejemplo: 
      { "data": { "muting": true } }
Si recibes “muting”: true, entonces el id está silenciando correctamente al target_user_id Para dejar de silenciar al mismo usuario, puedes usar la solicitud titulada “Unmute a user ID”, que también se encuentra en la carpeta “Mutes” de la colección de X API v2 cargada en Postman. El source_user_id debe ser tu ID de usuario y el target_user_id debe ser el ID de usuario que deseas dejar de silenciar. No tendrás que agregar esto como cuerpo JSON, por lo que debes asegurarte de añadir los parámetros de consulta necesarios para source_user_id y target_user_id. Si el des-silenciado se realiza correctamente, recibirás una respuesta similar al siguiente ejemplo: 
      { "data": { "muting": false } }