Início rápido

Este guia percorre as cinco chamadas de uma primeira integração. Todos os exemplos usam o servidor sandbox, https://sandbox.weshipyou.com/api/v1, então nada do que você fizer aqui é cobrado da sua carteira real. Leia Modo de teste e modo de produção antes de passar para produção.

Antes de começar#

• Seu usuário da WeShipYou. Você obtém um token do sandbox com seu login de produção: o sandbox guarda uma cópia de teste do seu usuário e das suas contas, sem saldo.
• Um terminal com curl, ou Node.js 18 ou mais recente (já vem com fetch).

1. Obtenha um token de acesso#

Faça login em produção com "mode": "test". A produção confere seu usuário e senha e responde com um token do sandbox. Se a autenticação de dois fatores estiver ativada para o seu usuário, envie também o código atual de 6 dígitos em twoFactorToken.

curl -X POST https://weshipyou.com/api/v1/authentication \
  -H "Content-Type: application/json" \
  -d '{"username": "janedoe", "password": "your-password", "mode": "test"}'

Guarde o accessToken em uma variável de ambiente. Os exemplos a seguir o leem de WSY_ACCESS_TOKEN:

export WSY_ACCESS_TOKEN="eyJhbGciOi..."

2. Encontre sua conta#

Os envios pertencem a uma conta. Liste as contas das quais você é membro e anote o accountNumber (começa com CU) daquela de onde você envia. As suas subcontas também aparecem na lista, cada uma com a conta principal em parentUid (veja Subcontas).

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

3. Crie um envio#

Envie o remetente, o destinatário e os pacotes. A resposta é o envio, com seu uid e os serviços com os quais ele pode ser enviado em parcel_rates.

curl -X POST https://sandbox.weshipyou.com/api/v1/shipments \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d @shipment.json

A referência de Criar um envio tem um shipment.json completo para começar.

4. Compre a etiqueta#

Escolha uma das parcel_rates e compre. O preço sai primeiro do saldo da sua carteira; só o que o saldo não cobre é cobrado em paymentMethod.

curl -X POST https://sandbox.weshipyou.com/api/v1/shipments/labels \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "CU1234567",
    "handoverOptions": [{
      "handoverOption": "dropoff",
      "shipments": [{ "shipmentId": "<shipment uid>", "rateId": "<parcel_rates[].uid>" }]
    }]
  }'

5. Rastreie#

Leia o envio para obter o número de rastreamento (label.trackingNumber) e depois consulte o status e os pontos de controle.

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

Próximos passos#

• Autenticação: duração do token, códigos de dois fatores e como proteger os tokens.
• Etiquetas: tarifas, pagamento, opções de entrega e cancelamento.
• Subcontas: crie, liste e envie em nome de uma delas.
• Erros: o que cada status significa e quando tentar de novo.