Authenticación

Para autenticarte en TraderPal Connect necesitas un API Key y un usuario con su contraseña. Puedes solicitar tus credenciales contactando a support@traderpal.co

El módulo de autenticación consiste de dos endpoints: login y refresh-toke,

Login

POST /v1/auth/login

Cuerpo de la Solicitud

{
  "email": "anakin.skywalker@tatooine.com",
  "password": "yourPa$$w0rd"
}

Headers

Se debe agregar el header para el api-key que será proporcionado por TraderPal y que luego tú puedes gestionar desde el dashboard de administración.

  HEADER
  
  api-key: **********************

Ejemplo de Respuesta

{
  "partnerUserId": "2946445a-f37d-4aaa-8327-e372adf763b8",
  "partnerId": "2946445a-f37d-4aaa-8327-e372adf763b8",
  "email": "anakin.skywalker@traderpal.com",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.............",
  "refreshToken": "2946445a-f37d-4aaa-8327-e372adf763b8",
  "expiration": "2023-10-15T06:00:00-06:00"
}

En la respuesta anterior se obtiene el "authToken" y el "refreshToken". El refreshToken podrá usarse para generar un nuevo token con el endpoint refresh-token, entes de que el actual expire. En la propiedad expiration se indica la fecha y hora de expiración del authToken.

El authToken deberá ser pasado en el header "Authorization" en cualquier llamada subsecuente a la API en la forma:

Authorization: bearer {authToken}

Usando como ejemplo la llamada anterior:

HEADER

Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.............

Refresh Token

POST /v1/auth/refresh-token

Cuerpo de la Solicitud

{
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refreshToken": "2946445a-f37d-4aaa-8327-e372adf763b8"
}

En la solicitud anterior se debe pasar el authToken recibido con el endpoint de login y el refreshToken.

Ejemplo de Respuesta

{
  "partnerUserId": "2946445a-f37d-4aaa-8327-e372adf763b8",
  "partnerId": "2946445a-f37d-4aaa-8327-e372adf763b8",
  "email": "anakin.skywalker@traderpal.com",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.............",
  "refreshToken": "2946445a-f37d-4aaa-8327-e372adf763b8",
  "expiration": "2023-10-15T06:00:00-06:00"
}

En la respuesta se obtiene un nuevo "authToken" con su nueva fecha de expiración.

Meores Prácticas de Seguridad

1. Almacene las Credenciales de Manera Segura

   • Nunca exponga sus credenciales en el código
   • Use variables de ambiente o bóvedas de seguridad
   • Rotar las API Keys periódicament. El dashboard de TraderPal Connect te permite generar una nueva API Key cuando lo desees.

2. Uso de HTTPS

   • Siempre usa HTTPS para los llamados a la API
   • Verifique los certifocados SSL

3. Maneje los Tokens de Manera Segura

   • Preferiblemente no almacene los tokens, manténgalos en memoria. Si los almacena hágalo de manera segura.
   • Implemente lógica de refrescamiento

Manejo de Errores

Errores comunes de autenticaci'on:

Código de Error	Descripción	Solución
401	Credenciales Inválidas	La API Key, usuario o contraseña son inválidos
404	Usuario no Encontrado	El usuario usado no existe

Próximos Pasos

• API Reference - Documentación detallada de toda la API
• Colección de Postman - Guía de uso de nuestra colección de Postman
• Guía de Integración - Pasos Para una Integración Óptima