Skip to content

Brisa API

Brisa is an API-first app. In addition, client libraries are auto-generated for Ruby, Python, and JavaScript. That means you don't have to worry about libraries becoming outdated if there's not a developer willing to keep it up-to-date.

Overview

Brisa clients need to know 2 things in order to connect:

  1. The Brisa API endpoint. For the SaaS app, that is https://app.brisaboards.com/brisa. For custom installations, it will be whatever domain or IP you install it on (hopefully SSL-protected!).
  2. The auth key for the connecting user. You can log in using my_client.User.login(user, pass), or you can create revokable user tokens that don't expire.

What can you do with the API?

Since Brisa is API-first, you can do anything that the web interface does. But some specific examples:

  • Collect information from a website and store it in Brisa. The initial Brisa contact form, as well as beta survey, were both stored in Brisa. The survey even updated individual fields so it could be viewed as a visitor filled out the survey!
  • Write command line tools and helpers. Need a quick task list? You could build something like:
    my_todo -a "Get milk"
    my_todo -l The entries would be visible in Brisa so you can choose between the web interface or CLI depending on convenience.