Documentación de la API de WEEX: cómo empezar a usar la API de trading de WEEX

Para empezar a usar la API de WEEX necesitas dos cosas: la documentación oficial de la API de WEEX y una clave API configurada para las funciones que quieras utilizar. WEEX ofrece recursos de API para el trading al contado y de futuros USDT-M. La documentación abarca datos de mercado, funciones de cuenta y operaciones de trading, así como la API REST y las conexiones WebSocket.

Los desarrolladores pueden acceder a los endpoints compatibles de datos públicos de mercado sin autenticación. Las funciones privadas, como la gestión de cuentas y órdenes, requieren una clave API y solicitudes autenticadas.

El proceso de configuración es sencillo: elige la documentación de la API de WEEX que corresponda, crea una clave API, configura los permisos necesarios, protege las credenciales y conecta tu aplicación al endpoint de API adecuado.

¿Dónde puedes encontrar la documentación oficial de la API de WEEX?

WEEX mantiene documentación específica sobre los productos e interfaces compatibles. Esta se actualiza cuando cambian las funciones de la API, y las páginas de cada endpoint incluyen ejemplos de solicitudes y respuestas para facilitar la integración. 

Para Spot V3, la documentación abarca el proceso de preparación, los dominios de la API, la autenticación, los datos de mercado, las funciones de cuenta y órdenes, las conexiones WebSocket, los límites de frecuencia y otros requisitos técnicos.

WEEX divide sus API en interfaces públicas y privadas. Las API públicas permiten obtener información de configuración y datos de mercado sin autenticación. Las API privadas incluyen funciones como la gestión de cuentas y órdenes, y requieren solicitudes autenticadas.

Antes de integrar la API, los desarrolladores deben consultar la documentación del producto que vayan a utilizar, ya que los endpoints y los requisitos técnicos pueden variar entre el mercado al contado y los futuros.

Cómo crear una clave API de WEEX

Para utilizar las funciones privadas de la API de WEEX, primero debes crear una clave API desde tu cuenta de WEEX. Según la documentación actual de Spot V3, estos son los pasos básicos:

1. Inicia sesión en WEEX a través de la plataforma web.
2. Abre la sección de gestión de API y crea una clave API nueva.
3. Configura los permisos que requiere tu integración.
4. Vincula una dirección IP si es adecuado para tu configuración.
5. Guarda de forma segura las credenciales de API generadas o configuradas durante el proceso.

Actualmente, cada cuenta de WEEX puede crear hasta 10 grupos de claves API. Esto permite mantener claves API independientes para distintas aplicaciones o configuraciones de trading, en lugar de depender de una sola clave para todas las conexiones.

Al crear una clave API, hay tres credenciales importantes: APIKey identifica al usuario de la API para la autenticación. SecretKey es la clave privada que se utiliza para generar las firmas de las solicitudes.

Passphrase la establece el usuario y es necesaria para el acceso autenticado. Si se pierde, WEEX indica que no se puede recuperar y que debe crearse una nueva clave API. Estas credenciales deben guardarse de forma segura y no compartirse con otras personas.

Cómo configurar los permisos de la API de WEEX

Las claves API nuevas de WEEX Spot tienen el permiso Solo lectura de forma predeterminada. Esto permite acceder a las funciones de consulta compatibles, pero no realizar operaciones de trading al contado.

Si una aplicación necesita colocar o cancelar órdenes al contado, debe habilitarse el permiso Spot correspondiente.

Por tanto, el permiso adecuado depende de las tareas que deba realizar la aplicación. Una herramienta que solo se utilice para supervisar saldos, consultar el historial de trading o analizar información puede mantener el permiso Solo lectura. Una aplicación diseñada para ejecutar órdenes al contado necesita el permiso de trading Spot.

WEEX también permite vincular las claves API a direcciones IP. La documentación oficial advierte de que las claves API sin restricciones ni vinculación de IP conllevan un riesgo de seguridad adicional y recomienda vincular una dirección IP al crear una clave.

Una medida práctica consiste en conceder a cada integración únicamente los permisos que necesita, en lugar de habilitar accesos adicionales que la aplicación no vaya a utilizar.

Cómo conectarse a la API REST de WEEX

Cuando tengas lista la clave API y sus permisos, podrás conectar tu aplicación a la API REST de WEEX. WEEX ofrece endpoints de API REST para datos de mercado, información de la cuenta y las operaciones de trading compatibles.

Los endpoints públicos permiten obtener información del mercado sin autenticación. Los endpoints privados, como las funciones de cuenta y órdenes, requieren autenticación con tus credenciales de API y deben cumplir los requisitos de firma indicados en la documentación oficial de la API de WEEX.

Un buen punto de partida es probar una solicitud pública de datos de mercado antes de pasar a las funciones autenticadas. Cuando la conexión funcione, podrás utilizar los endpoints privados adecuados según los permisos habilitados para tu clave API.

Como los endpoints de API y los requisitos técnicos pueden actualizarse, consulta siempre la versión más reciente de la documentación de la API de WEEX al configurar tu integración.

Cómo comprobar la conexión de tu API de WEEX

Una forma sencilla de iniciar una integración es confirmar que la aplicación puede comunicarse correctamente con la API de WEEX antes de añadir funciones de trading más complejas.

Para empezar, puedes utilizar solicitudes de la API pública, ya que no requieren autenticación. Cuando la conexión básica funcione, podrás probar solicitudes autenticadas según los permisos asignados a la clave API.

Si una solicitud autenticada falla, quizá debas revisar varios aspectos de la configuración, como las credenciales de API, los permisos, la firma de la solicitud, la marca de tiempo, el dominio de la API y las restricciones de IP.

WEEX exige que las solicitudes autenticadas utilicen un método de firma estandarizado. Según la documentación actual de V3, la marca de tiempo de la solicitud se expresa en milisegundos y una solicitud puede rechazarse si su marca de tiempo difiere en más de 30 segundos de la hora del servidor de la API de WEEX. 

Probar la conexión paso a paso facilita identificar si el problema está relacionado con la conectividad, la autenticación, los permisos o la solicitud concreta.

¿Qué debes comprobar antes de usar la API de WEEX para hacer trading?

Antes de usar la API de WEEX para hacer trading, revisa los permisos de tu clave API y asegúrate de que solo tenga los accesos que necesita tu aplicación. WEEX también recomienda vincular las claves API a direcciones IP de confianza y proteger la clave API, SecretKey y Passphrase.

Los desarrolladores también deben consultar los límites de frecuencia actuales de la API y gestionar correctamente los errores de las solicitudes. Superar los límites aplicables puede hacer que se rechacen las solicitudes, por lo que los sistemas automatizados deben diseñarse para respetar los límites especificados en la documentación oficial.

Antes de utilizar la API para operar en directo, prueba cuidadosamente la conexión, la autenticación, los permisos y la lógica de las órdenes. Para consultar los requisitos de seguridad y los límites de frecuencia más recientes, revisa la documentación actual de la API de WEEX.

Conclusión

Para empezar a usar la API de WEEX, debes elegir la documentación oficial adecuada, crear una clave API, configurar sus permisos, proteger las credenciales y conectar una aplicación al endpoint de API correspondiente.

Los desarrolladores pueden empezar con solicitudes de la API pública antes de pasar a las funciones autenticadas de cuenta o trading. La documentación más reciente de la API de WEEX debe seguir siendo la referencia técnica principal para consultar los endpoints actuales, los requisitos de autenticación, los permisos y los límites de frecuencia.

Preguntas frecuentes

1. ¿Dónde puedo encontrar la documentación oficial de la API de WEEX?
WEEX ofrece documentación específica sobre sus productos de API, endpoints, autenticación, conexiones WebSocket, parámetros y ejemplos de respuestas. Los desarrolladores deben utilizar la versión más reciente, ya que las funciones de la API pueden actualizarse con el tiempo.

2. ¿Cómo creo una clave API de WEEX?
Inicia sesión en la plataforma web de WEEX y abre la sección de gestión de API para crear y configurar una clave API. Actualmente, cada cuenta puede crear hasta 10 grupos de claves API.

3. ¿Qué información debo guardar después de crear una clave API de WEEX?
Guarda de forma segura APIKey, SecretKey y Passphrase. No es posible recuperar una Passphrase perdida, por lo que, si la pierdes, tendrás que crear una clave API nueva.

4. ¿Qué permisos tiene una clave API nueva de WEEX?
Una clave API nueva de Spot tiene el permiso Solo lectura de forma predeterminada. Para realizar operaciones de trading al contado, debe habilitarse el permiso de trading Spot correspondiente.

5. ¿Por qué no funciona mi solicitud a la API de WEEX?
Entre las causas habituales están las credenciales incorrectas, los permisos insuficientes, los errores de firma, las diferencias en la marca de tiempo, las restricciones de IP o los límites de frecuencia. Según el error que devuelva la solicitud, consulta la sección correspondiente de la documentación oficial de la API de WEEX.