Developers
Developers
Quick Summary: Access your API credentials, sandbox environment, and MCP tokens to integrate with the Floship API programmatically.
Overview
The Developers page provides everything you need to integrate your systems with the Floship API. You can view your production and sandbox API credentials, generate tokens, explore the API documentation, and manage MCP access for AI-powered integrations.
Note: If you don't see the Developers option in your menu, ask your company administrator to grant you Developers access.
Prerequisites
- Your user account must have the Developers permission enabled
- API access is available to accounts with the Developers permission enabled
Quick Start
- Click your username in the top-right corner
- Select Developers
- View your Production API credentials
- Copy the API Token to use in your integration
- Review the API Resources section for available endpoints
- Click Explore to open the full API documentation
Detailed Guide
API Resources
The page displays available API resource categories with brief descriptions. Click Explore to open the interactive API documentation where you can see all available endpoints, request/response formats, and try sample calls.
API Credentials
Production
Your production credentials connect to live data:
| Field | Description |
|---|---|
| Production URL | The base URL for all production API calls |
| API Token | Your authentication token for production requests |
Use the Regenerate button to create a new production token if your current one is compromised.
Warning: Regenerating your production token immediately invalidates the old one. All integrations using the old token will stop working until updated.
Sandbox
The sandbox environment lets you test integrations without affecting real data:
| Field | Description |
|---|---|
| Sandbox URL | The base URL for sandbox API calls |
| Sandbox Token | Authentication token for sandbox requests |
| Sandbox Username | Login username for the sandbox portal |
| Sandbox Password | Login password for the sandbox portal |
Use Regenerate buttons to create new sandbox credentials as needed.
Tip: Always test new integrations in the sandbox environment first before switching to production.
MCP Access
MCP (Model Context Protocol) tokens allow AI assistants and tools to interact with your Floship data.
| Field | Description |
|---|---|
| MCP Endpoint | The URL for MCP connections |
| MCP Token | Bearer token for MCP authentication |
Use Request Token to generate your first MCP token, or Regenerate to create a new one.
Common Workflows
Workflow: Set Up a New Integration
When: You want to connect an external system to Floship via the API.
Steps: 1. Go to Developers 2. Copy the Sandbox URL and Sandbox Token 3. Configure your integration to use the sandbox credentials 4. Test by creating and retrieving sample data 5. Once verified, switch to the Production URL and API Token
Result: Your integration is connected and can exchange data with Floship.
Workflow: Regenerate a Compromised Token
When: You suspect your API token has been exposed or compromised.
Steps: 1. Go to Developers 2. Find the affected credential (Production, Sandbox, or MCP) 3. Click Regenerate 4. Copy the new token 5. Update all integrations that use this token
Result: The old token is immediately invalidated. Only the new token works.
Workflow: Access API Documentation
When: You want to see available endpoints and how to use them.
Steps: 1. Go to Developers 2. Click Explore 3. Browse the interactive documentation for endpoints, parameters, and response formats
Result: The API documentation opens with a full reference of available endpoints.
Troubleshooting
| Issue | Cause | Solution |
|---|---|---|
| Cannot see Developers in menu | Your account does not have the Developers permission | Ask your company administrator to grant you Developers access |
| API calls return 401 Unauthorized | Token is invalid, expired, or regenerated | Go to Developers and copy the current token; update your integration |
| Sandbox data does not appear in production | Sandbox and production are separate environments | Recreate your setup using production credentials when ready to go live |
| MCP token request fails | Feature may not be available for your account | Contact your Account Manager to enable MCP access |