Autenticação

Obter um token de acesso

POST/authentication

O objeto Token de acesso

Atributos

accessTokenstring
iatnumber
expnumber
userobject
Atributos aninhados
- idnumber
- uidstring
- usernamestring
- emailstring
- isEnabledboolean | integer
- isVerifiedboolean | integer
- invalidTokensBeforeAtstring <date-time>aceita null
- metadataobjectaceita null
- termsAgreementDatestring <date-time>aceita null
- termsAgreementVersionstringaceita null
- createdAtstring <date-time>
- updatedAtstring <date-time>
- deletedAtstring <date-time>aceita null
- roleIdnumber
- avatarIdnumberaceita null
- revisionnumberaceita null
- roleobject
- avatarobject
- user_detailobject
  Atributos aninhados
  idnumberaceita null
  uidstringaceita null
  taxIdstringaceita null
  phonestringaceita null
  firstNamestringaceita null
  lastNamestringaceita null
  displayNamestringaceita null
  genderstringaceita null
  languagestringaceita null
  birthdaystring <date-time>aceita null
  createdAtstring <date-time>aceita null
  updatedAtstring <date-time>aceita null
  deletedAtstring <date-time>aceita null
  userIdnumberaceita null
- accountslista de Conta
  pelo menos 1 itens · no máximo 100 itens
  Atributos aninhados
  namestringobrigatório
  pelo menos 1 caracteres
  displayNamestringobrigatório
  pelo menos 1 caracteres
  systemUnitsstringobrigatório
  Valores permitidos:imperialmetric
  emailstringobrigatório
  pelo menos 1 caracteres
  notificationEmailstringobrigatório
  pelo menos 1 caracteres
  websitestringobrigatórioaceita null
  phonestringobrigatórioaceita null
  pelo menos 1 caracteres
  emergencyPhonestringobrigatórioaceita null
  pelo menos 1 caracteres
  taxIdstringaceita null
  taxIdCountryobjectaceita null
  Atributos aninhados
  isoCodestringobrigatório
  uidstringsomente leitura
  accountNumberstringsomente leitura
  parentUidstringaceita nullsomente leitura
  O uid da conta principal quando esta é uma subconta; null caso contrário.
  statusstringsomente leitura
  languagestringobrigatório
  isBusinessboolean | integerobrigatório
  allowBankAccountPaymentsboolean | integersomente leitura
  metadataobjectaceita nullsomente leitura
  createdAtstring <date-time>somente leitura
  updatedAtstring <date-time>somente leitura
  deletedAtstring <date-time>aceita nullsomente leitura
  addressIdnumberaceita nullsomente leitura
  billingAddressIdnumberaceita nullsomente leitura
  defaultShipFromIdnumberaceita nullsomente leitura
  defaultAddressOnLabelIdnumberaceita nullsomente leitura
  defaultReturnAddressIdnumberaceita nullsomente leitura
  primaryPaymentShipmentsIdnumberaceita nullsomente leitura
  logoIdnumberaceita nullsomente leitura
  pickupServiceFallbackIdnumberaceita nullsomente leitura
  revisionnumberaceita nullsomente leitura
  addressEndereço da conta | object
  Endereço principal da conta.
  Atributos aninhados
  Um de
  uidstringobrigatórioaceita null
  UID do endereço. Use-o como accountAddressId, ou como uid do remetente / destinatário em um envio.
  nicknamestringaceita null
  Nome exibido nos catálogos de endereços.
  namestringaceita null
  Nome do contato.
  companyNamestringaceita null
  Nome da empresa.
  taxIdstringaceita null
  Documento fiscal do contato.
  emailstringaceita null
  E-mail do contato.
  phonestringaceita null
  Telefone do contato, E.164.
  birthdaystring <date-time>aceita null
  Data de nascimento do contato, quando coletada.
  isRecipientboolean | integeraceita null
  O endereço pode receber envios. 1/true ou 0/false.
  isSenderboolean | integeraceita null
  O endereço pode enviar envios. 1/true ou 0/false.
  isResidentialboolean | integeraceita null
  O endereço é residencial. 1/true ou 0/false.
  statusstringobrigatórioaceita null
  Status do registro.
  addressobjectaceita null
  Endereço postal. Incluído quando o endereço é lido sozinho.
  Atributos aninhados
  cityobject
  Atributos aninhados
  namestringaceita null
  stateobject
  Atributos aninhados
  streetstring
  Endereço, incluindo o número do prédio ou apartamento.
  postalCodestring
  countryobjectaceita null
  País do endereço. Incluído quando o endereço é lido sozinho.
  Atributos aninhados
  isoCodestring
  Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
  exatamente 2 caracteres
  createdAtstring <date-time>obrigatórioaceita null
  Quando o endereço foi salvo.
  updatedAtstring <date-time>obrigatórioaceita null
  Quando o endereço mudou pela última vez.

O objeto Token de acesso

{
  "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
      }
    ]
  }
}

Obter um token de acesso

POST/authentication

Não precisa de token de acesso

Troca o seu usuário e senha (mais o código de dois fatores, quando ativado) por um token de acesso JWT. Envie-o como Authorization: Bearer <accessToken> em todas as outras requisições.

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Corpo da requisiçãoapplication/json

O seu login na WeShipYou.

usernamestringobrigatório
O seu usuário ou e-mail da WeShipYou.
Padrão: {{username}}
passwordstringobrigatório
A sua senha.
Padrão: {{password}}
twoFactorTokenstring
O código atual de 6 dígitos do seu app autenticador. Obrigatório quando a autenticação em dois fatores está ativada para o seu usuário.
corresponde a ^[0-9]{6}$
modestring
test no servidor de produção: você entra com seu usuário e senha de produção e a resposta é um token do Sandbox. O sandbox recebe uma cópia de teste do seu usuário, das suas contas e das suas associações (sem saldo, métodos de pagamento ou dados de verificação), atualizada a cada login de teste. Todo token traz a claim livemode: true na produção, false no sandbox.
Valores permitidos:livetest
Padrão: live

Respostas

201

O objeto Token de acesso

400

Requisição inválida

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

401

Usuário ou senha incorretos; Two-factor authentication required (com data.twoFactorRequired: true) quando falta o código; Invalid two-factor code quando ele está errado.

namestring
Sempre NotAuthenticated
messagestring
codenumber
Sempre 401
classNamestring
Sempre not-authenticated
dataobject
Atributos aninhados
- twoFactorRequiredboolean

409

Somente com mode: "test": o sandbox já tem outro usuário com o seu nome de usuário ou e-mail.

namestring
Sempre Conflict
messagestring
codenumber
Sempre 409
classNamestring
Sempre conflict

503

Somente com mode: "test": não foi possível contatar o sandbox ou ele não conseguiu abrir a sessão de teste. Seu acesso à produção não é afetado; tente novamente em um minuto.

namestring
Sempre Unavailable
messagestring
codenumber
Sempre 503
classNamestring
Sempre 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"
}'

Resposta

{
  "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
      }
    ]
  }
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.