Saltar al contenido principalEsta página contiene información sobre varias herramientas y conceptos clave que debes conocer al integrar los endpoints de mutes en tu sistema. Hemos dividido la página en un par de secciones:
Antes de profundizar en algunos conceptos clave que le ayudarán a integrar este endpoint, le recomendamos familiarizarse con:
Postman es una excelente herramienta que puedes usar para probar un endpoint. Cada solicitud de Postman incluye todos los parámetros de ruta y de cuerpo para ayudarte a comprender rápidamente qué tienes disponible. Para obtener más información sobre nuestras colecciones de Postman, visita nuestra página “Uso de Postman”.
¿Te interesa configurar este endpoint con código en tu lenguaje de programación preferido? Tenemos varios ejemplos de código disponibles que puedes usar como punto de partida en nuestra página de GitHub.
Aprovecha una de las bibliotecas de terceros creadas por nuestra comunidad para empezar. Puedes encontrar una biblioteca compatible con los endpoints v2 buscando la etiqueta de versión correspondiente.
Todos los endpoints de X API v2 requieren autenticar tus solicitudes con un conjunto de credenciales, también conocidas como claves y tokens. Puedes usar Contexto de usuario de OAuth 1.0a o Código de autorización de OAuth 2.0 con PKCE para autenticar tus solicitudes a estos endpoints.
Contexto de usuario de OAuth 1.0a requiere utilizar tus API Keys, user Access Tokens y otros parámetros para crear un encabezado de autorización, que luego enviarás con tu solicitud. Los Access Tokens deben estar asociados con el usuario en cuyo nombre realizas la solicitud. Si deseas generar un conjunto de Access Tokens para otro usuario, ese usuario debe autorizar tu App utilizando el flujo OAuth de 3 patas.
Ten en cuenta que OAuth 1.0a puede ser difícil de usar. Si no estás familiarizado con este método de autenticación, te recomendamos usar una biblioteca, usar una herramienta como Postman o usar OAuth 2.0 para autenticar tus solicitudes.
Código de autorización de OAuth 2.0 con PKCE permite un mayor control sobre el alcance de una aplicación y flujos de autorización en múltiples dispositivos. OAuth 2.0 te permite elegir ámbitos granulares que te otorgan permisos específicos en nombre de un usuario.
Para habilitar OAuth 2.0 en tu App, debes activarlo en la configuración de autenticación de tu App, ubicada en la sección de configuración de la App del Portal de desarrolladores.
Portal de desarrolladores, Proyectos y Apps de desarrollador
Para obtener un conjunto de credenciales de autenticación que funcione con los endpoints de la X API v2, debes registrarte para obtener una cuenta de desarrollador, configurar un Proyecto dentro de esa cuenta y crear una App de desarrollador dentro de ese Proyecto. Luego podrás encontrar tus claves y tokens dentro de tu App de desarrollador.
Cada día, miles de desarrolladores realizan solicitudes a la X API. Para gestionar el gran volumen de estas solicitudes, se aplican límites de frecuencia a cada endpoint que restringen la cantidad de solicitudes que puedes realizar en nombre de tu App o de un usuario autenticado.
Estos endpoints tienen límites de frecuencia a nivel de usuario, lo que significa que el usuario autenticado en cuyo nombre haces la solicitud solo puede invocar el endpoint un número determinado de veces desde cualquier App de desarrollador.
Existe un límite de frecuencia por usuario de 50 solicitudes por endpoint cada 15 minutos para los métodos POST y DELETE. En cambio, para el método GET, el límite es de solo 15 solicitudes cada 15 minutos.
El endpoint GET de X API v2 permite seleccionar exactamente qué data se desea obtener de la API mediante un conjunto de herramientas llamadas fields y expansions. El parámetro expansions permite ampliar los objetos referenciados en el payload. Por ejemplo, este endpoint permite obtener las siguientes expansions:
El parámetro fields permite seleccionar exactamente qué fields dentro de los distintos objetos de data se desea recibir. Este endpoint devuelve principalmente objetos User. De forma predeterminada, el objeto User retorna los campos id, name y username. Para recibir campos adicionales como user.created_at o user.entities, se deben solicitar específicamente utilizando un parámetro fields.
Hemos añadido una guía sobre cómo usar fields y expansions conjuntamente en nuestro diccionario de data de X API v2.
La consulta de silenciados puede devolver una gran cantidad de datos. Para garantizar resultados coherentes y de alto rendimiento en todo momento, usamos paginación. La paginación es una función de los endpoints de X API v2 que devuelve más resultados de los que pueden incluirse en una sola respuesta. Cuando eso sucede, los datos se devuelven en una serie de “páginas”. Obtén más información sobre cómo paginar los resultados.
Ten en cuenta: Si un usuario silencia desde X, hay un límite de 200 solicitudes cada 15 minutos.