Best Practice Software · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Halo Cloud API for Desktop Applications

2 actions 2 updates update extends openapi/haloconnect-desktop-openapi.json

Derived by API Evangelist Built from the contracts Best Practice Software publishes. Best Practice Software did not publish this file.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-providerx-apievangelist-apix-apievangelist-authx-apievangelist-accessx-apievangelist-tokenx-apievangelist-artifacts

Targets 1

$.info

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Halo Cloud API for Desktop Applications
  version: 1.0.0
extends: openapi/haloconnect-desktop-openapi.json
actions:
- target: $.info
  update:
    x-apievangelist-provider: best-practice
    x-apievangelist-api: best-practice:halo-cloud-desktop-api
    x-apievangelist-auth: azure-apim-subscription-key + bearer-jwt + device-id
    x-apievangelist-access: partner-gated (Halo Cloud subscription + per-practice pairing)
    x-apievangelist-token: obtainToken issues a short-lived Desktop API token; renew periodically
- target: $.info
  update:
    x-apievangelist-artifacts:
      authentication: authentication/best-practice-authentication.yml
      conventions: conventions/best-practice-conventions.yml
      errors: errors/best-practice-problem-types.yml

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/best-practice-desktop-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.