Getting Started
Getting Started

Authentication

Authentication uses OAuth bearer tokens. Call GET https://app.ship.com/public/token with your account email and password sent as HTTP request headers named email and password. The response contains a token valid for 180 days and a refreshToken. Include the token on every request as Authorization: Bearer <token>. When it expires, mint a new one with POST /public/refresh, sending {"refresh_token": "..."} — your refresh token itself never changes.

Include your bearer token in the Authorization header of all requests:

1Authorization: Bearer <token>

All endpoints require an OAuth2 Bearer token in the Authorization header.

Common Errors

Errors return a JSON envelope:

  1. Invalid Credentials
  2. Expired Credentials