Autenticação

A API autentica cada solicitação com um JSON Web Token (JWT). Não há chaves de API: você faz login com o mesmo usuário e senha que usa no site e recebe um token.

Obtenha um token#

Envie seu usuário (ou e-mail) e sua senha. A resposta traz o accessToken, seu vencimento exp (um timestamp Unix) e o seu usuário.

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

Autenticação de dois fatores#

Se a autenticação de dois fatores estiver ativada para o seu usuário, o login também precisa do código atual de 6 dígitos do seu app autenticador, em twoFactorToken:

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

Sem o código, o login responde 401 com data.twoFactorRequired: true; um código errado responde 401 Invalid two-factor code. Os códigos mudam a cada 30 segundos, então uma integração que roda sem supervisão precisa fazer login quando alguém puder digitar o código, ou usar um usuário sem dois fatores limitado ao que a integração precisa.

Envie o token#

Coloque o token no cabeçalho Authorization de todas as outras solicitações:

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

• Sem token, ou com um vencido ou malformado: 401 NotAuthenticated.
• Um token de um usuário que não é membro da conta: 403 Forbidden ou 404 NotFound.

Quando o token vence (em exp), faça login de novo. Não há token de renovação.

Tokens de teste e de produção#

O sandbox e o servidor de produção têm usuários e tokens separados. Um token de um é recusado pelo outro. Leia Modo de teste e modo de produção.