Autenticación

La API autentica cada solicitud con un JSON Web Token (JWT). No hay claves de API: inicias sesión con el mismo usuario y contraseña que usas en el sitio web y recibes un token.

Obtén un token#

Envía tu usuario (o correo) y tu contraseña. La respuesta trae el accessToken, su vencimiento exp (una marca de tiempo Unix) y tu usuario.

{
  "username": "janedoe",
  "password": "your-password"
}

Autenticación de dos factores#

Si la autenticación de dos factores está activada para tu usuario, el inicio de sesión también necesita el código actual de 6 dígitos de tu app de autenticación, en twoFactorToken:

{
  "username": "janedoe",
  "password": "your-password",
  "twoFactorToken": "123456"
}

Sin el código, el inicio de sesión responde 401 con data.twoFactorRequired: true; un código incorrecto responde 401 Invalid two-factor code. Los códigos cambian cada 30 segundos, así que una integración que funciona sin supervisión tiene que iniciar sesión cuando alguien pueda escribir el código, o usar un usuario sin dos factores limitado a lo que la integración necesita.

Envía el token#

Pon el token en la cabecera Authorization de cada una de las demás solicitudes:

curl https://sandbox.weshipyou.com/api/v1/accounts \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

• Sin token, o con uno vencido o mal formado: 401 NotAuthenticated.
• Un token de un usuario que no es miembro de la cuenta: 403 Forbidden o 404 NotFound.

Cuando el token vence (en exp), vuelve a iniciar sesión. No hay token de renovación.

Tokens de prueba y reales#

El sandbox y el servidor real tienen usuarios y tokens separados. Un token de uno es rechazado por el otro. Lee Modo de prueba y modo real.