Guía de integración

​

Guía de integración

Esta página contiene información sobre varias herramientas y conceptos fundamentales que debes conocer al integrar los endpoints de miembros de List en tu sistema. Hemos dividido la página en varias secciones:

• Herramientas útiles
• Conceptos clave
• Autenticación
• Portal de desarrolladores, Project y App
• Límite de tasa
• fields y expansions
• Paginación

​

Herramientas útiles

Antes de profundizar en algunos conceptos clave que le ayudarán a integrar este endpoint, le recomendamos familiarizarse con:

​

Postman

Postman es una excelente herramienta que puede usar para probar un endpoint. Cada solicitud de Postman incluye todos los parámetros de ruta y de cuerpo para ayudarlo a comprender rápidamente qué tiene disponible. Para obtener más información sobre nuestras colecciones de Postman, visite nuestra página “Using Postman”. 

​

Ejemplos de código

¿Le interesa configurar este endpoint con código en su lenguaje de programación preferido? Tenemos varios ejemplos de código disponibles que puede usar como punto de partida en nuestra página de GitHub.

​

Bibliotecas de terceros

Aprovecha una de las bibliotecas de terceros creadas por nuestra comunidad para ayudarte a empezar. Puedes encontrar una biblioteca compatible con los endpoints de v2 buscando la etiqueta de versión correspondiente.

​

Conceptos clave

​

Autenticación

Todos los endpoints de X API v2 requieren que autentiques tus solicitudes con un conjunto de credenciales, también conocidas como keys and tokens. Puedes usar Contexto de usuario de OAuth 1.0a, Código de autorización de OAuth 2.0 con PKCE o App only para autenticar tus solicitudes en los endpoints de Lists de lookup. Sin embargo, debes autenticarte con Contexto de usuario de OAuth 1.0a u OAuth 2.0 para los endpoints de Lists de manage.

Contexto de usuario de OAuth 1.0a, lo que significa que debes usar un conjunto de API Keys y Access Tokens de usuario para realizar una solicitud correcta. Los access tokens deben estar asociados con el usuario en cuyo nombre estás realizando la solicitud. Si deseas generar un conjunto de Access Tokens para otro usuario, ese usuario debe autorizar tu App mediante el flujo de OAuth de 3 fases.

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 library, utilizar una herramienta como Postman o usar OAuth 2.0 o App only para autenticar tus solicitudes.

Código de autorización de OAuth 2.0 con PKCE permite un mayor control sobre el alcance (scope) de una aplicación y los flujos de autorización en múltiples dispositivos. OAuth 2.0 te permite elegir scopes específicos y granulares que te otorgan permisos concretos 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 del portal de desarrolladores.

App only solo requiere que incluyas un App only Access Token en tu solicitud. Puedes generar un App only Access Token directamente dentro de una App de desarrollador o generar uno usando el endpoint POST oauth2/token.

App only solo requiere que incluyas un App only Access Token en tu solicitud. Puedes generar un App only Access Token directamente dentro de una App de desarrollador o generar uno usando el endpoint POST oauth2/token.

​

Portal de desarrolladores, Projects 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 Project dentro de esa cuenta y crear una App de desarrollador dentro de ese Project. Luego podrás encontrar tus keys and tokens dentro de tu App de desarrollador.  

​

Límites de tasa

Cada día, muchos miles de desarrolladores realizan solicitudes a la X API. Para ayudar a gestionar el gran volumen de estas solicitudes, se aplican límites de tasa a cada endpoint que restringen la cantidad de solicitudes que puedes hacer en nombre de tu App o de un usuario autenticado. 

Los endpoints de consulta (GET) tienen límites de tasa tanto a nivel de App como a nivel de usuario, mientras que los endpoints de gestión (POST/DELETE) están limitados a nivel de usuario. El límite de tasa de la App significa que tú, como desarrollador, solo puedes realizar una cierta cantidad de solicitudes a este endpoint durante un período determinado desde cualquier App (ya sea utilizando la API Key y la Clave secreta de la API, o el App only Access Token). El límite de tasa de usuario significa que el usuario autenticado en cuyo nombre realizas la solicitud solo puede realizar consultas de List una cantidad determinada de veces desde cualquier App de desarrollador.

La siguiente tabla muestra los límites de tasa para cada endpoint.

Endpoint	método HTTP	límite de tasa
/2/lists/:id/members	GET	900 solicitudes por 15 minutos
/2/users/:id/list_memberships	GET	75 solicitudes por 15 minutos
/2/lists/:id/members	POST	300 solicitudes por 15 minutos
/2/lists/:id/members/:user_id	DELETE	300 solicitudes por 15 minutos

​

Campos y expansiones

El endpoint GET de X API v2 permite seleccionar exactamente qué data desea recuperar de la API mediante un conjunto de herramientas llamados fields y expansions. El parámetro expansions permite ampliar los objetos referenciados en el payload. Por ejemplo, consultar los miembros de una List permite obtener las siguientes expansions:

• pinned_tweet_id

El parámetro fields permite seleccionar exactamente qué fields dentro de los diferentes objetos de data desea recibir. La consulta de miembros de una List entrega principalmente objetos de usuario. De forma predeterminada, el objeto de usuario devuelve los campos id, name y username. Para recibir campos adicionales como user.created_at o user.description, tendrá que solicitarlos específicamente usando el parámetro user.fields. 

Hemos agregado una guía sobre cómo usar fields y expansions.

La tabla siguiente muestra los fields y expansions disponibles para cada endpoint de consulta:

Endpoint	Fields	Expansions
/2/lists/:id/members	user.fields tweet.fields	pinned_tweet_id
/2/users/:id/list_memberships	list.fields user.fields	owner_id

​

Paginación

La consulta de membresías/miembros puede devolver una gran cantidad de data. Para garantizar resultados coherentes y de alto rendimiento en todo momento, utilizamos paginación. La paginación es una función de los endpoints de X API v2 que devuelve más resultados de los que se pueden incluir en una sola respuesta. Cuando eso sucede, la data se devuelve en una serie de “páginas”. Obtén más información sobre cómo paginar los resultados.