Guía de integración

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

• Herramientas útiles
• Conceptos clave
• Autenticación
• Portal de desarrolladores, Projects y Apps
• Límites de uso
• Fields y Expansions

​

Herramientas útiles

Antes de entrar en algunos conceptos clave que le ayudarán a integrar este endpoint, le recomendamos familiarizarse 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” (/es/tutorials/postman-getting-started). 

​

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

Aproveche una de las bibliotecas de terceros creadas por nuestra comunidad para empezar. Puede encontrar una biblioteca compatible 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 el 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 realizas 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 pasos.

Ten en cuenta que OAuth 1.0a puede resultar difícil de usar. Si no estás familiarizado con este método de autenticación, te recomendamos utilizar una biblioteca 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 X API v2, debes registrarte para una cuenta de desarrollador, configurar un Project (Project) dentro de esa cuenta y crear una App de desarrollador (App de desarrollador) dentro de ese Project. 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 alto volumen de estas solicitudes, se imponen límites de uso en cada endpoint que restringen la cantidad de solicitudes que puede realizar en nombre de su App o de un usuario autenticado.

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

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

Endpoint	Método HTTP	Límite de uso
/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 expansions

El endpoint GET de X API v2 permite seleccionar exactamente qué datos quieres obtener de la API utilizando un conjunto de herramientas llamadas fields y expansions. El parámetro expansions te permite ampliar 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é fields dentro de los distintos objetos de datos deseas recibir. Este endpoint devuelve 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, tendrás que solicitarlos 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 datos de X API v2.

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

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