🔐 API Authentication Guide

Use your API key to securely authenticate requests to the ShipGenius API.

📘 1. Get Your API Key

Generate an API key from the Apps page in your ShipGenius account.
Each key is tied to a specific app and its permissions.

🔑 2. Add the Key to Your Requests

Include the API key in the Authorization header using the Bearer schema:

Authorization: Bearer YOUR_API_KEY

🌐 3. Base URL for Requests

Make GraphQL requests to one of the following endpoints depending on the environment:

• Sandbox: https://sandbox.lite.shipgeni.us/graphql (coming soon)
• Production: https://api.lite.shipgeni.us/graphql

✅ 4. Test the Authentication

Run the ping query to confirm your credentials:

query {
  ping {
    name
    ip_address
    permissions
    current_datetime
  }
}

You’ll receive your app name, IP address, permissions, and the datetime of the request.