Skip to main content

How to Find Your VESYL API Key

Learn how to quickly locate and manage your VESYL API Key to integrate VESYL’s powerful shipping software with third-party platforms.

Updated this week

VESYL’s Shipping API enables seamless integration between your shipping workflows and third-party platforms—allowing you to automate order processing, update shipment statuses, and synchronize data effortlessly.

To connect VESYL with external tools, you’ll need your unique API Key. Here’s a simple guide to locating and managing it.


Step-by-Step: Locating Your API Key

  1. Open Settings
    Click your name or profile icon located at the bottom left corner of the VESYL dashboard to open the main menu.

  2. Select Settings from the options.

    The settings tab highlighted on the left hand sidebar
  3. Access Developer Settings
    In the Settings menu, locate and click Developer Settings.
    This section houses all developer-related configurations including your API Key.

  4. View and Copy Your API Key
    Click View next to the API Key field to reveal your key.
    Use the Copy button to copy the key securely to your clipboard.

The developer settings tab highlighted and the copy button for the API key highlighted below

Keep Your API Key Secure

  • Your API Key grants access to your VESYL account data—treat it like a password.

  • Do not share your API Key publicly or with unauthorized users.

  • If you believe your key has been compromised, regenerate a new one immediately via Developer Settings.


What Can You Do with VESYL’s Shipping API?

VESYL’s Shipping API empowers your business to:

  • Integrate shipping data with your ERP, WMS, or custom dashboards.

  • Automate order fulfillment by syncing orders, shipments, returns, and reshipments.

  • Pull real-time shipment status updates to keep customers informed automatically.

  • Create custom workflows that match your operational needs perfectly.

Learn more about the API’s capabilities, endpoints, and authentication details on our Shipping API page.


Tips for API Integration

  • Use the API Key in your requests’ authorization headers as per VESYL’s API documentation.

  • Test your integration first in a sandbox or test environment before deploying live.

  • Monitor API usage and rate limits to avoid disruptions.

  • Reach out to VESYL Support for any help with advanced integrations or troubleshooting.


Summary

  • Find your API Key under Settings > Developer Settings.

  • Keep your key secure and regenerate if needed.

  • Use the API to connect, automate, and optimize your shipping workflows.

If you want help with specific integrations or examples, feel free to contact us!

Did this answer your question?