Saltar al contenido principal

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 listas en tu sistema. Hemos dividido la página en varias secciones:

Herramientas útiles

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

Postman

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 “Postman の使用”

Ejemplos de código

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

Bibliotecas de terceros

Aprovecha alguna de las bibliotecas de terceros de nuestra comunidad para empezar. Puedes encontrar una que funcione con los endpoints de la v2 buscando la etiqueta de versión correspondiente.

Conceptos clave

Autenticación

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, Código de autorización de OAuth 2.0 con PKCE o App only para autenticar tus solicitudes a los endpoints de lookup de Listas. Sin embargo, debes autenticarte con Contexto de usuario de OAuth 1.0a u OAuth 2.0 para los endpoints de manage de Listas. OAuth 1.0a User Context, 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 haces la solicitud. Si deseas generar un conjunto de Access Tokens para otro usuario, ese usuario debe autorizar tu App mediante 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 librería, 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 de una aplicación y flujos de autorización entre múltiples dispositivos. OAuth 2.0 te permite elegir permisos específicos y granulares (scopes) que te otorgan facultades concretas 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. App only solo requiere que envíes un Access Token de App only con tu solicitud. Puedes generar un Access Token de App only directamente en una App de desarrollador o generarlo usando el endpoint POST oauth2/token. App only solo requiere que envíes un Access Token de App only con tu solicitud. Puedes generar un Access Token de App only directamente en una App de desarrollador o generarlo usando el endpoint POST oauth2/token.

Portal de desarrolladores, Proyectos y Apps de desarrollador

Para obtener un conjunto de credenciales de autenticación que funcione con los endpoints de X API v2, debes registrarte para 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.  

Límites de uso

Cada día, miles de desarrolladores realizan solicitudes a la X API. Para ayudar a gestionar el gran volumen de estas solicitudes, se aplican límites de uso a cada endpoint que restringen cuántas solicitudes puedes hacer en nombre de tu App o de un usuario autenticado. Los endpoints de consulta (GET) tienen límites 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 a nivel de App significa que tú, como desarrollador, solo puedes realizar una cantidad determinada de solicitudes a este endpoint durante un período concreto desde cualquier App (ya sea usando la API Key y la API Secret Key, o el App-only Access Token). El límite a nivel de usuario significa que el usuario autenticado en cuyo nombre haces la solicitud solo puede realizar consultas de List un número determinado de veces desde cualquier App de desarrollador. La siguiente tabla muestra los límites de uso para cada endpoint.
EndpointMétodo HTTPLímite
/2/lists/:id/membersGET900 solicitudes por 15 minutos
/2/users/:id/list_membershipsGET75 solicitudes por 15 minutos
/2/lists/:id/membersPOST300 solicitudes por 15 minutos
/2/lists/:id/members/:user_idDELETE300 solicitudes por 15 minutos

Fields y expansions

El endpoint GET de X API v2 permite a los usuarios seleccionar exactamente qué data desean obtener de la API utilizando un conjunto de herramientas llamadas fields y expansions. El parámetro expansions te permite expandir objetos referenciados en el payload. Por ejemplo, consultar los miembros de una Lista te permite obtener las siguientes expansions:
  • pinned_tweet_id
El parámetro fields te permite seleccionar exactamente qué fields dentro de los distintos objetos de data deseas recibir. La consulta de miembros de una Lista devuelve 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ás 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:
EndpointFieldsExpansions
/2/lists/:id/membersuser.fields

tweet.fields
pinned_tweet_id
/2/users/:id/list_membershipslist.fields

user.fields
owner_id
Consultar membresías/miembros puede devolver muchos datos. Para garantizar resultados consistentes 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 devuelven 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.