Autenticación

Obtener un token de acceso

POST/authentication

El objeto Token de acceso

Atributos

accessTokenstring
iatnumber
expnumber
userobject
Atributos anidados
- idnumber
- uidstring
- usernamestring
- emailstring
- isEnabledboolean | integer
- isVerifiedboolean | integer
- invalidTokensBeforeAtstring <date-time>admite null
- metadataobjectadmite null
- termsAgreementDatestring <date-time>admite null
- termsAgreementVersionstringadmite null
- createdAtstring <date-time>
- updatedAtstring <date-time>
- deletedAtstring <date-time>admite null
- roleIdnumber
- avatarIdnumberadmite null
- revisionnumberadmite null
- roleobject
- avatarobject
- user_detailobject
  Atributos anidados
  idnumberadmite null
  uidstringadmite null
  taxIdstringadmite null
  phonestringadmite null
  firstNamestringadmite null
  lastNamestringadmite null
  displayNamestringadmite null
  genderstringadmite null
  languagestringadmite null
  birthdaystring <date-time>admite null
  createdAtstring <date-time>admite null
  updatedAtstring <date-time>admite null
  deletedAtstring <date-time>admite null
  userIdnumberadmite null
- accountslista de Cuenta
  al menos 1 elementos · como máximo 100 elementos
  Atributos anidados
  namestringobligatorio
  al menos 1 caracteres
  displayNamestringobligatorio
  al menos 1 caracteres
  systemUnitsstringobligatorio
  Valores permitidos:imperialmetric
  emailstringobligatorio
  al menos 1 caracteres
  notificationEmailstringobligatorio
  al menos 1 caracteres
  websitestringobligatorioadmite null
  phonestringobligatorioadmite null
  al menos 1 caracteres
  emergencyPhonestringobligatorioadmite null
  al menos 1 caracteres
  taxIdstringadmite null
  taxIdCountryobjectadmite null
  Atributos anidados
  isoCodestringobligatorio
  uidstringsolo lectura
  accountNumberstringsolo lectura
  parentUidstringadmite nullsolo lectura
  El uid de la cuenta principal cuando esta es una subcuenta; null en otro caso.
  statusstringsolo lectura
  languagestringobligatorio
  isBusinessboolean | integerobligatorio
  allowBankAccountPaymentsboolean | integersolo lectura
  metadataobjectadmite nullsolo lectura
  createdAtstring <date-time>solo lectura
  updatedAtstring <date-time>solo lectura
  deletedAtstring <date-time>admite nullsolo lectura
  addressIdnumberadmite nullsolo lectura
  billingAddressIdnumberadmite nullsolo lectura
  defaultShipFromIdnumberadmite nullsolo lectura
  defaultAddressOnLabelIdnumberadmite nullsolo lectura
  defaultReturnAddressIdnumberadmite nullsolo lectura
  primaryPaymentShipmentsIdnumberadmite nullsolo lectura
  logoIdnumberadmite nullsolo lectura
  pickupServiceFallbackIdnumberadmite nullsolo lectura
  revisionnumberadmite nullsolo lectura
  addressDirección de la cuenta | object
  Dirección principal de la cuenta.
  Atributos anidados
  Uno de
  uidstringobligatorioadmite null
  UID de la dirección. Úsalo como accountAddressId, o como uid del remitente / destinatario en un envío.
  nicknamestringadmite null
  Nombre que se muestra en las libretas de direcciones.
  namestringadmite null
  Nombre del contacto.
  companyNamestringadmite null
  Nombre de la empresa.
  taxIdstringadmite null
  Id fiscal del contacto.
  emailstringadmite null
  Correo del contacto.
  phonestringadmite null
  Teléfono del contacto, E.164.
  birthdaystring <date-time>admite null
  Fecha de nacimiento del contacto, cuando se recopila.
  isRecipientboolean | integeradmite null
  La dirección puede recibir envíos. 1/true o 0/false.
  isSenderboolean | integeradmite null
  La dirección puede enviar envíos. 1/true o 0/false.
  isResidentialboolean | integeradmite null
  La dirección es residencial. 1/true o 0/false.
  statusstringobligatorioadmite null
  Estado del registro.
  addressobjectadmite null
  Dirección postal. Se incluye cuando la dirección se lee sola.
  Atributos anidados
  cityobject
  Atributos anidados
  namestringadmite null
  stateobject
  Atributos anidados
  streetstring
  Dirección, incluido el número de edificio o apartamento.
  postalCodestring
  countryobjectadmite null
  País de la dirección. Se incluye cuando la dirección se lee sola.
  Atributos anidados
  isoCodestring
  Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
  exactamente 2 caracteres
  createdAtstring <date-time>obligatorioadmite null
  Cuándo se guardó la dirección.
  updatedAtstring <date-time>obligatorioadmite null
  Cuándo cambió la dirección por última vez.

El objeto Token de acceso

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6ImFjY2VzcyJ9.eyJzdWIiOiJjeGZ0b2N2bTJsY2ciLCJhdWQiOiJodHRwczovL3dlc2hpcHlvdS5jb20ifQ.SIGNATURE",
  "iat": 1793493470,
  "exp": 1825029470,
  "user": {
    "id": 1,
    "uid": "cxftocvm2lcg",
    "username": "janedoe",
    "email": "jane.doe@example.com",
    "isEnabled": 1,
    "isVerified": 1,
    "invalidTokensBeforeAt": null,
    "metadata": null,
    "termsAgreementDate": null,
    "termsAgreementVersion": null,
    "createdAt": "2026-11-01T00:37:50.000Z",
    "updatedAt": "2026-11-01T00:37:50.000Z",
    "deletedAt": null,
    "roleId": 1,
    "avatarId": null,
    "revision": null,
    "role": {
      "id": 1,
      "name": "customer",
      "inheritPermissionsFromRoleId": null,
      "inheritPermissionsFromRole": {
        "id": null,
        "name": null
      }
    },
    "avatar": {
      "id": null,
      "uid": null,
      "md5": null,
      "height": null,
      "width": null,
      "format": null,
      "awsUrl": null
    },
    "user_detail": {
      "id": null,
      "uid": null,
      "taxId": null,
      "phone": null,
      "firstName": null,
      "lastName": null,
      "displayName": null,
      "gender": null,
      "language": null,
      "birthday": null,
      "createdAt": null,
      "updatedAt": null,
      "deletedAt": null,
      "userId": null
    },
    "accounts": [
      {
        "name": "Acme Imports",
        "displayName": "Acme Imports",
        "systemUnits": "metric",
        "email": "jane.doe@example.com",
        "notificationEmail": "jane.doe@example.com",
        "website": null,
        "phone": null,
        "emergencyPhone": null,
        "taxId": null,
        "uid": "l96f0r4g37om",
        "accountNumber": "0000ACC1X1",
        "status": "active",
        "language": "en",
        "isBusiness": 0,
        "allowBankAccountPayments": 0,
        "metadata": null,
        "createdAt": "2026-11-01T00:37:50.000Z",
        "updatedAt": "2026-11-01T00:37:50.000Z",
        "deletedAt": null,
        "addressId": null,
        "billingAddressId": null,
        "defaultShipFromId": null,
        "defaultAddressOnLabelId": null,
        "defaultReturnAddressId": null,
        "primaryPaymentShipmentsId": null,
        "logoId": null,
        "pickupServiceFallbackId": null,
        "revision": null,
        "address": null
      }
    ]
  }
}

Obtener un token de acceso

POST/authentication

No necesita token de acceso

Intercambia tu usuario y contraseña (más el código de dos factores cuando está activado) por un token de acceso JWT. Envíalo como Authorization: Bearer <accessToken> en todas las demás solicitudes.

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Cuerpo de la solicitudapplication/json

Tu inicio de sesión de WeShipYou.

usernamestringobligatorio
Tu usuario o correo de WeShipYou.
Por defecto: {{username}}
passwordstringobligatorio
Tu contraseña.
Por defecto: {{password}}
twoFactorTokenstring
El código actual de 6 dígitos de tu app de autenticación. Obligatorio cuando tu usuario tiene activada la autenticación de dos factores.
cumple ^[0-9]{6}$
modestring
test en el servidor de producción: inicias sesión con tu usuario y contraseña de producción y la respuesta es un token de Sandbox. El sandbox recibe una copia de prueba de tu usuario, tus cuentas y tus membresías (sin saldo, métodos de pago ni datos de verificación), que se actualiza en cada inicio de sesión de prueba. Cada token lleva un claim livemode: true en producción, false en el sandbox.
Valores permitidos:livetest
Por defecto: live

Respuestas

201

Sesión iniciada

El objeto Token de acceso

400

Solicitud no válida

namestring
Siempre BadRequest
messagestring
codenumber
Siempre 400
classNamestring
Siempre bad-request
dataobject

401

Usuario o contraseña incorrectos; Two-factor authentication required (con data.twoFactorRequired: true) cuando falta el código; Invalid two-factor code cuando es incorrecto.

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject
Atributos anidados
- twoFactorRequiredboolean

409

Solo con mode: "test": el sandbox ya tiene otro usuario con tu nombre de usuario o tu email.

namestring
Siempre Conflict
messagestring
codenumber
Siempre 409
classNamestring
Siempre conflict

503

Solo con mode: "test": no se pudo contactar el sandbox o no pudo abrir la sesión de prueba. Tu acceso a producción no se ve afectado; inténtalo de nuevo en un minuto.

namestring
Siempre Unavailable
messagestring
codenumber
Siempre 503
classNamestring
Siempre unavailable

POST/authentication

curl -X POST 'https://sandbox.weshipyou.com/api/v1/authentication' \
  -H "Content-Type: application/json" \
  -d '{
  "username": "janedoe",
  "password": "correct-horse-battery-staple",
  "twoFactorToken": "123456"
}'

Respuesta

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6ImFjY2VzcyJ9.eyJzdWIiOiJjeGZ0b2N2bTJsY2ciLCJhdWQiOiJodHRwczovL3dlc2hpcHlvdS5jb20ifQ.SIGNATURE",
  "iat": 1793493470,
  "exp": 1825029470,
  "user": {
    "id": 1,
    "uid": "cxftocvm2lcg",
    "username": "janedoe",
    "email": "jane.doe@example.com",
    "isEnabled": 1,
    "isVerified": 1,
    "invalidTokensBeforeAt": null,
    "metadata": null,
    "termsAgreementDate": null,
    "termsAgreementVersion": null,
    "createdAt": "2026-11-01T00:37:50.000Z",
    "updatedAt": "2026-11-01T00:37:50.000Z",
    "deletedAt": null,
    "roleId": 1,
    "avatarId": null,
    "revision": null,
    "role": {
      "id": 1,
      "name": "customer",
      "inheritPermissionsFromRoleId": null,
      "inheritPermissionsFromRole": {
        "id": null,
        "name": null
      }
    },
    "avatar": {
      "id": null,
      "uid": null,
      "md5": null,
      "height": null,
      "width": null,
      "format": null,
      "awsUrl": null
    },
    "user_detail": {
      "id": null,
      "uid": null,
      "taxId": null,
      "phone": null,
      "firstName": null,
      "lastName": null,
      "displayName": null,
      "gender": null,
      "language": null,
      "birthday": null,
      "createdAt": null,
      "updatedAt": null,
      "deletedAt": null,
      "userId": null
    },
    "accounts": [
      {
        "name": "Acme Imports",
        "displayName": "Acme Imports",
        "systemUnits": "metric",
        "email": "jane.doe@example.com",
        "notificationEmail": "jane.doe@example.com",
        "website": null,
        "phone": null,
        "emergencyPhone": null,
        "taxId": null,
        "uid": "l96f0r4g37om",
        "accountNumber": "0000ACC1X1",
        "status": "active",
        "language": "en",
        "isBusiness": 0,
        "allowBankAccountPayments": 0,
        "metadata": null,
        "createdAt": "2026-11-01T00:37:50.000Z",
        "updatedAt": "2026-11-01T00:37:50.000Z",
        "deletedAt": null,
        "addressId": null,
        "billingAddressId": null,
        "defaultShipFromId": null,
        "defaultAddressOnLabelId": null,
        "defaultReturnAddressId": null,
        "primaryPaymentShipmentsId": null,
        "logoId": null,
        "pickupServiceFallbackId": null,
        "revision": null,
        "address": null
      }
    ]
  }
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.