This API is the current main API. Support will be at least through 2024.

Overview

Support for staging and dev environments
- the staging and dev environment is not something we promise to be live at all times.
The documentation uses the Open API (OAS3) standard:
- Generate code
- Types

See our Javascript tutorial Make the Handy move (API) where we use the API.

How to use

The detailed technical documentation can be found here:

<aside> 💡 You can play around and use the function in the browser in our online documentation using the Swagger API UI.

</aside>

Check out the tutorial Make the Handy move (API) where we test to manipulate a Handy masturbator by controlling the online API documentation.

You can generate a typed class for all our APIs.

Add openapi-typescript-codegen to your project:

npm i -D openapi-typescript-codegen

Here is the suggested import script (add it to scripts in your package.json file):

"importApi": "openapi --exportSchemas true --input <https://www.handyfeeling.com/api/handy/v2/spec> --output src/_HANDYAPI --name HandyApi",

Import the API by running:

npm run importApi

Check Code generator OAS3 for more information. Or the tutorial where we generate code for Handy API v2 here: