Skip to main content

Buerli Headless API Examples


This documentation provides an overview of the Buerli Headless API examples repository, which demonstrates various features and capabilities of the Buerli Headless API. The examples are self-contained and can be easily accessed by cloning the repository. Each example focuses on a specific feature or use case, providing clear instructions on how to use the API effectively.


Before getting started with the examples, please ensure you have the following prerequisites:

  • Buerli Headless API credentials: Obtain your *.capp file from Buerli.
  • Git: Install Git to clone the repository and access the examples.
  • API documentation: Familiarity with the Buerli Headless API documentation is recommended for better understanding of the underlying concepts and methods.
  • Cloning the Repository
  • To access the Buerli Headless API examples, follow these steps:

Open a terminal or command prompt.

Run the following command to clone the repository:

git clone

Once the cloning process is complete, navigate to the repository's directory.

Running an Example#

yarn start