HawkSoft Clients API
Client records including contacts, policies, coverages, vehicles, and drivers
HawkSoft Clients API is one of 5 APIs that HawkSoft publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Clients. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 4 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 3.0.
Requests are made against a single base URL, https://integration.hawksoft.app.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
HawkSoft Clients API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
basicAuth— HTTP Basic authentication with partner-issued credentials.
Paths & Operations 4
Across 3 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Client records including contacts, policies, coverages, vehicles, and drivers
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Policy (8 properties), Client (6 properties), Contact (6 properties), ClientReference (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HawkSoft 4
Other APIs HawkSoft publishes across the network.