API Clients

Once you have your shiny new e-commerce API up and running, you will likely want to test it out!

Testing Locally

Locally you can use tools such as Postman (opens new window) or Insomnia (opens new window) to connect to your API and make requests manually.

If you are really impatient and want to see something work right now, try hitting the / endpoint to get basic information about your API. If you followed the installation instructions this will be at http://localhost:8000/api/v1/.

Connecting to Storefronts

It is highly recommended that the GetCandy API is used to power a modern NuxtJS (opens new window) or React (opens new window) storefront. You can of course connect to the API via Axios yourself, however you will probably benefit from using a JS client library generated from the OpenAPI specification, see API Reference.

Or if you would prefer, you can use our pre-generated JS library (opens new window).

TIP

Check our PWA Storefront (opens new window) built in NuxtJS!