Skip to main content

Quick Start Guide

API Overview​

The Solv Partner API is a RESTful API that uses JSON for data exchange. Here are the key points:

  • Base URLs:
  • All requests require an x-api-key header with your client ID
  • Responses are in JSON format with meta and data top-level keys
  • Different endpoints require specific scopes. To obtain a token with the necessary permissions, provide the appropriate scope when calling POST /v1/auth/token during authentication. Once you have the token with the correct scope, use it to access the desired endpoint.

Obtain API Credentials​

  • Client ID​

  • Client Secret​

Get an Access Token​

Make a POST request to obtain an access token. Don’t forget to set the “x-api-key” in the header to your client ID and select the proper base URL.

POST 
/v1/auth/token
HTTP/1.1
Host: partner-api.solvhealth.com
Content-Type: application/json

{
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "grant_type": "client_credentials",
  "scope": "read:locations" // or another scope like 
      "read:bookings" or "write:bookings"
}

The response will include an access_token which you'll use for subsequent API calls.

Making your first API Call​

Let's make a simple API call to get information about a location:

GET 
/v1/partner/locations/ABC123 
HTTP/1.1
Host: partner-api.solvhealth.com
Authorization: Bearer YOUR_ACCESS_TOKEN
x-api-key: YOUR_CLIENT_ID

Replace ABC123 with an actual location ID, YOUR_ACCESS_TOKEN with the token obtained in step 3, and YOUR_CLIENT_ID with your client ID.

Common Endpoints used in Booking Lifecycle

Let's walk through a typical booking lifecycle using Solv's Developer Toolkit:

  • Check for Availability​

    Use the Find available slots endpoint to get available, bookable slots at your desired location.

    GET 
    /v2/partner/locations/{location_id}/slots

  • Create a Booking​

    Use the Create booking endpoint to create a new booking at the selected open slot.

    POST 
    /v1/partner/bookings
    {
      "appointment_date": "2023-06-15T14:30:00Z",
      "birth_date": "1990-01-01",
      "first_name": "Jane",
      "last_name": "Doe",
      "location_id": "ABC123",
      "phone": "+14155551234",
      "email": "jane.doe@example.com",
      "reason": "Annual checkup"
    }

  • Check in your patient​

    Use the Update booking status endpoint to update the booking when the patient has arrived at the clinic.

    PATCH 
    /v1/partner/bookings/BOOK123  
    HTTP/1.1
    Host: partner-api.solvhealth.com
    Authorization: Bearer YOUR_ACCESS_TOKEN
    x-api-key: YOUR_CLIENT_ID
    Content-Type: application/json

    {
      "status": "checked_in"
    }

  • Check Insurance Info​

    Use the Get insurance card images endpoint to retrieve the front and back insurance card image URLs for a specific booking.

    GET 
     /v1/partner/bookings/{booking_id}/insurance-card

  • Discharge your patient's booking​

    Use the Update booking status endpoint to update the booking when the patient has completed their visit.

    PATCH 
     /v1/partner/bookings/BOOK123 
    HTTP/1.1
    Host: partner-api.solvhealth.com
    Authorization: Bearer YOUR_ACCESS_TOKEN
    x-api-key: YOUR_CLIENT_ID
    Content-Type: application/json

    {
      "status": "discharged"
    }

Next Steps​

You're ready to get started! Explore our full API documentation to learn about all of our available endpoints. If you have any questions or need assistance, your Partner Success Consultant is available to help with your build.