Introduction
The whole of Ohana rests on a few key concepts, that are also reflected in the Object Model. An understanding of these concepts as well as the relationships between them will make it trivial to work with Ohana for customization, extension, or integration scenarios.
Conventions
In order to work with Ohana, you will need a valid, authorized account, and an API key. Log in with administrative access, navigate to Settings>Security>API Keys. Enter the key information, and make sure that you keep the private information secure. Unfortunately, if lost, API keys can only be deleted and re-generated. They cannot be retrieved, and the public key displayed when an access token is firs generated should be saved in a secure place immediately.
If you have not seen them before, we recommend our videos on the Ohana API. You can also check out our Getting Started Guide and our Tutorials to help you get started with navigating your endpoint and retrieving your data on demand.
The base URL to send all API requests is https://api.hvman.ai. HTTPS is required for all API requests.
The Hvman API follows RESTful conventions when possible, with most operations performed via GET, POST, PATCH, and DELETE requests on page and database resources. Request and response bodies are encoded as JSON.
A complete listing of all Swagger API calls can be found at https://api.hvman.ai/swagger-ui.html, but that is accessible only to authorized users.
JSON conventions
-
Top-level resources have an "object" property. This property can be used to determine the type of resource (e.g. "agent", "product", "review", etc.
-
Top-level resources are addressable by a UUIDv4 "id" property. You may omit dashes from the ID when making requests to the API, e.g. when copying the ID from a Hvman URL.
-
Property names are in snake_case (not camelCase or kebab-case).
-
Temporal values (dates and datetimes) are encoded in ISO 8601 strings. Datetimes will include the time value (2024-04-12T02:12:33.231Z) while dates will include only the date (2024-04-12)
-
The Hvman API does not support empty strings. To unset a string value for properties like a url Property value object, for example, use an explicit null instead of "".
Hvman API
Code samples & SDKs
Sample requests and responses are shown for each endpoint. Requests are shown using the Hvman JavaScript SDK, and cURL. These samples make it easy to copy, paste, and modify as you build your integration.
In addition, the Swagger Page also allows you to send sample requests to the registered endpoint, and to retrieve information for your user. Because of tenancy and data restrictions, you will be able to access this API only once you are authenticated, and will be able to request information only for resources that belong to you.
Pagination
Endpoints that return lists of objects support cursor-based pagination requests. By default, Ohana returns twenty items per API call. If the number of items in a response from a support endpoint exceeds the default, then an integration can use pagination to request a specific set of the results and/or to limit the number of returned items.
Supported endpoints
Method | URL | Description |
|---|---|---|
GET | https://api.hvman.ai/ohanaCoupons/search/findByCouponAndSessionId | Coupon search |
GET | https://api.hvman.ai/ohanaCoupons | Find coupon |
GET | https://api.hvman.ai/ohanaAgents | Retrieve agent information |
GET | https://api.hvman.ai/ohanaActions | All actions performed for a particular session |
Responses
All endpoints return a response in JSON format by default. At this point in time, no other response formats are supported.