A API da WeShipYou é organizada segundo o REST. Ela tem URLs previsíveis e orientadas a recursos, aceita corpos de requisição em JSON, retorna respostas em JSON e usa os códigos de status e verbos HTTP padrão.
Testes e produção
Teste primeiro a sua integração no servidor Sandbox (sandbox.weshipyou.com): nada do que você faz lá chega a uma transportadora real nem movimenta dinheiro real. O servidor de Produção (weshipyou.com) é real: as etiquetas compradas lá são cobradas da sua carteira.
A API trabalha com um objeto por requisição; não há atualizações em massa.
OpenAPI
Esta referência é gerada a partir de um documento OpenAPI 3.1. Baixe-o em /docs/api/openapi.json e importe-o no Postman ou em qualquer ferramenta compatível com OpenAPI.
Requisições de origem cruzada
A API aceita CORS de qualquer origem, então você pode chamá-la a partir de um navegador. Nunca coloque um token de acesso em código que outras pessoas possam ler.
Autenticação
A API autentica cada requisição com um JSON Web Token (JWT). Não há chaves de API.
- Chame
POST /authenticationcom o seu usuário (ou e-mail) da WeShipYou e a sua senha. Se a autenticação em dois fatores estiver ativada para o seu usuário, envie também o código atual de 6 dígitos do seu app autenticador comotwoFactorToken. - Envie o
accessTokenrecebido em todas as outras requisições, no cabeçalhoAuthorization: Bearer <accessToken>. - O token expira em
exp(um timestamp Unix na resposta). Faça login de novo para obter outro.
Uma requisição sem um token válido responde 401 NotAuthenticated. Uma requisição para uma conta da qual você não é membro responde 403 Forbidden ou 404 NotFound.
- JWT
- HTTP bearer · JWT
O token de acesso de
POST /authentication(válido até o seuexp), enviado comoAuthorization: Bearer <accessToken>.Envie como Authorization: Bearer <token>