Guía de integración

Esta página contiene información sobre varias herramientas y conceptos clave que deberías conocer al integrar los endpoints de mutes en tu sistema. Hemos dividido la página en varias secciones:

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

​

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 para probar un endpoint. Cada solicitud en Postman incluye todos los parámetros de ruta y de cuerpo para ayudarte a entender rápidamente qué opciones tienes disponibles. Para obtener más información sobre nuestras colecciones de Postman, visita la página “Using Postman”. 

​

Ejemplos de código

¿Le interesa configurar este endpoint con código en su lenguaje de programación preferido? Contamos con varios ejemplos de código que puede 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 biblioteca compatible con los endpoints de v2 buscando la etiqueta de versión correspondiente.

​

Conceptos clave

​

Autenticación

Todos los endpoints de la X API v2 requieren que autentiques tus solicitudes con un conjunto de credenciales, también conocido como keys and tokens. Puedes usar Contexto de usuario de OAuth 1.0a para autenticar tus solicitudes a este endpoint. 

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 correctamente. 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, este 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 o una herramienta como Postman.

​

Portal de desarrolladores, Projects y Apps de desarrollador

Para obtener un conjunto de credenciales de autenticación que funcionen 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 realizar en nombre de tu App o 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 invocar el endpoint un número determinado de veces en 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/users/:id/pinned_lists	POST	50 solicitudes por 15 minutos
/2/users/:id/pinned_lists/:list_id	DELETE	50 solicitudes por 15 minutos
/2/users/:id/pinned_lists	GET	15 solicitudes por 15 minutos

​

Campos y expansiones

El endpoint GET de la X API v2 permite seleccionar con precisión qué data se desea obtener de la API mediante un conjunto de herramientas llamadas fields y expansions. El parámetro expansions permite incluir (expandir) objetos referenciados en el payload. Por ejemplo, al consultar List fijadas, se pueden obtener las siguientes expansions:

• owner_id

El parámetro fields permite elegir exactamente qué fields dentro de los distintos objetos de datos se quieren recibir. Este endpoint entrega principalmente objetos de usuario. De forma predeterminada, el objeto List devuelve los campos id y name. Para recibir campos adicionales como list.created_at o list.description, será necesario solicitarlos explícitamente mediante un parámetro fields. 

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

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

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