Guía de integración

Esta página aborda las herramientas y conceptos clave para integrar los endpoints de listas fijadas.

---

​

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 “Uso de Postman”.

​

Ejemplos de código

¿Quieres 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.

​

Bibliotecas de terceros

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

---

​

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 claves y tokens. Puedes usar OAuth 1.0a User Context para autenticar tus solicitudes a este endpoint.

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

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 que uses una biblioteca o una herramienta como Postman.

​

Consola de desarrollador, 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 Project dentro de esa cuenta y crear una App de desarrollador dentro de ese Project. Luego podrás encontrar tus claves y 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 en nombre de un usuario autenticado.

Estos endpoints tienen límites de tasa a nivel de usuario, lo que significa que el usuario autenticado en cuyo nombre estás realizando la solicitud solo puede llamar al endpoint un número determinado de veces desde cualquier App de desarrollador.

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

Endpoint	Método HTTP	Límite de tasa
/2/users/:id/pinned_lists	POST	50 solicitudes cada 15 minutos
/2/users/:id/pinned_lists/:list_id	DELETE	50 solicitudes cada 15 minutos
/2/users/:id/pinned_lists	GET	15 solicitudes cada 15 minutos

​

Campos y expansions

El endpoint GET de X API v2 permite a los usuarios seleccionar exactamente qué datos quieren que se devuelvan desde la API utilizando un conjunto de herramientas llamado fields y expansions. El parámetro expansions te permite incluir objetos referenciados en el payload. Por ejemplo, consultar listas fijadas te permite obtener las siguientes expansions:

• owner_id

El parámetro fields te permite seleccionar exactamente qué campos dentro de los distintos objetos de datos deseas recibir. Este endpoint devuelve principalmente objetos de usuario. De forma predeterminada, el objeto Lista devuelve los campos id y name. Para recibir campos adicionales, como list.created_at o list.description, tendrás que solicitarlos específicamente utilizando el parámetro fields.

Hemos añadido a nuestro diccionario de datos de X API v2 una guía sobre cómo usar juntos fields y expansions.

La tabla siguiente muestra los campos y expansions disponibles para el endpoint de consulta:

Endpoint	Campos	Expansions
/2/users/:id/pinned_lists	list.fields, user.fields	owner_id