Location Based API Keys (a Qualiphy account per clinic)
The Locations: Qualiphy API add-on lets each clinic connect its own Qualiphy account: the clinic adds its own Qualiphy API key, and consultations for that clinic's orders go to that clinic's account instead of yours. The 1.2.5 changelog calls it Location Based API Keys. Products and consultations stay shared across your store; only the Qualiphy account is per clinic.
Turn it on
- Make sure the Locations add-on is on; this add-on requires it.
- Go to Qualiphy → Add-Ons and switch on Locations: Qualiphy API ("Qualiphy account required for each location."). It's off by default.
- Have each clinic add its key (below), or import keys with a CSV file, where they're tested right away.
Turning the add-on off keeps the stored keys, and turning it back on picks up where it left off.
How a clinic adds its key
The clinic's primary contact goes to My Account → My Clinic → Settings, Qualiphy API Key card. It first asks "Do you have a Qualiphy account?": Yes shows the key field, and Sign Up opens app.qualiphy.me/signup in a new window for clinics without an account. They paste the key and save (see Finding your Qualiphy API key).
Other staff see "Only the clinic's primary contact can manage the API key." As a site admin, you can set, change or remove any clinic's key on Qualiphy → Locations: open the clinic and use its Qualiphy API Key card (Save & Verify).
How verification works
Each key is tested before it's used: it has to list consultations, and the account has to be able to issue a test consultation. A failure shows Verification Failed with the reason. "The API key was accepted but the account could not issue a test meeting." means the key is fine but the account can't issue consultations yet; the clinic's Qualiphy account representative can sort that out.
A failed test never replaces a working key. The clinic keeps its current key and stays available, and the message adds "The key you were using before has not been changed." The exception is re-saving the key already on file: that's a re-test, and if it fails, the key is marked as failed and the clinic is hidden.
Clinics without a working key are hidden
While the add-on is on, clinics without a verified key disappear from the clinic picker, its state list and ?clinic= links. If an order for such a clinic gets through anyway (for example, from a cached page), its consultation invite is refused with "This clinic does not have a verified Qualiphy API key on file." in the order notes; it's never sent to your main account instead. Verify the key, then use Order actions → Create Qualiphy Invite on the order.
When a key stops working
If Qualiphy rejects a clinic's key as unauthorized or invalid while sending a consultation invite, the plugin marks the key as failed, hides the clinic, and adds a Clinic API Key Failed notification to the bell on Qualiphy → Dashboard, saying the clinic stays hidden until the primary contact re-verifies the key. It isn't emailed, so watch the unread count on the Qualiphy menu. Network problems, timeouts and errors unrelated to the key don't switch a key off.
To bring the clinic back, the primary contact re-verifies the key in My Clinic, or you re-enter it on the clinic's edit screen. Then re-send the failed invite from the order.
Checking key status
- Qualiphy → Locations: an API key badge per clinic, and an API filter for Verified, Not set or Error. Hover a badge for its meaning, such as "Last verification failed. Clinic is hidden from the patient-facing selector."
- System Log (on Qualiphy → Dashboard): the "Location Based API Keys" section lists each clinic's key status, last 4 characters, verified date and last error.
Which orders use the clinic's key
- An order credited to a clinic uses that clinic's verified key for its consultation invite and for Speak to a Doctor follow-ups.
- Once an order's first invite is accepted, the order stays on that Qualiphy account, even if you turn the add-on off later.
- Orders invited before the add-on was first turned on stay on your main API key, and so do orders with no clinic.
Because these consultations run on the clinic's account, the wp-admin order screen doesn't show their meeting link or Patient Exam ID, even to admins with clinical access. The plugin registers its webhook address for every verified clinic key, so results still reach your store (see The Webhooks page and unmatched webhooks).
Removing a key
On Qualiphy → Locations, open the clinic, click Remove on its Qualiphy API Key card and confirm. With no key on file, the clinic is hidden from customers until a new key is verified.
After a site move
Clinic keys are stored encrypted with your site's WordPress security keys. If those change, the security keys notice counts how many clinic keys need entering again; re-enter each from My Clinic or the clinic's edit screen. See "Security keys changed" notice.
Related
Still stuck? We're quick to respond.
Email [email protected]. Available 7 days a week, 7 AM to 6 PM PT.