Open API 2.0 Overview

Open API 1.0 Retiring August 12, 2026

Open API 1.0 will be retired on August 12, 2026. If you are currently integrated with Open API 1.0, please begin your Open API 2.0 integration as soon as possible. Open API 2.0 is a completely new integration approach, not an incremental upgrade, so plan accordingly. Contact support@vectorcare.com to get started.

Open API 2.0 is a greatly simplified integration that uses webhooks as the primary method for receiving service request data. This represents a significant architectural shift from v1.0, providing real-time updates with a consistent, static data structure.

What’s Different from 1.0?

• Webhook-driven architecture: All trip data comes from webhooks rather than polling endpoints
• Static data structure: Unchanging field names for simpler mapping and maintenance
• Simplified request status: A new request_status field provides a clear view of where requests stand
• Better standing order support: Individual webhook messages for each request in a collection
• Consolidated endpoints: State and location updates use a single API URL

Environment Selector

Use the environment selector in the header to switch between UAT and Production. All URLs in the documentation will update automatically.

What’s Available

Receiving Webhooks

VectorCare pushes all service request data to your endpoint in real-time via webhooks. There are no polling endpoints in v2.0.

1. Get started with your VectorCare UAT environment
2. Build your webhook endpoint to receive request data
3. Verify webhook signatures to ensure authenticity

Reporting Trip Progress

Most integrations also send data back to VectorCare:

• State Updates - Report trip milestones (en route, arrived, completed)
• Location Updates - Send GPS coordinates for live tracking

Service Request Actions

These endpoints let you interact with service requests beyond reporting trip progress:

• Accept/Decline - Accept or decline service requests broadcast to your organization
• Best Time - Propose your best available time for a service request
• Change Request - Request a change to the agreed pickup time
• Create Request - Programmatically create service requests (requires coordination with VectorCare)

Integration Support

We’re here to help you with your Open API 2.0 integration. Reach out to support@vectorcare.com to get started, and we can:

• Set up UAT access: Get access to VectorCare’s test environment for development and testing
• Create a dedicated channel: We’ll spin up a Slack, Teams, or other channel for your team to communicate directly with us
• Schedule a walkthrough: We’re happy to walk through the integration together on a call

Plain Text Version

View complete guide as plain text