Skip to content
Baack
Book a stack auditBook an audit
Menu

Getting started with Baack APIs

Browse the docs
Developer

This guide provides a comprehensive overview of how to get started with the Baack (Backend as a Cloud Key) APIs. It covers the essential steps for authentication, making your first API call, and understanding the core functionalities.

1. Authentication

To access the Baack APIs, you'll need to authenticate your requests. Baack APIs use API keys for authentication.Obtaining Your API Key

  1. Sign Up/Log In: If you don't already have one, create an account on the Baack developer portal.
  2. Navigate to API Keys: Once logged in, go to the "API Keys" section of your dashboard.
  3. Generate a new Key: Click on "Generate New API Key" and follow the prompts. Make sure to copy and store your API key securely, as it will not be shown again.

Using Your API Key

Your API key should be included in the Bearer-Token header of every request you make to the Baack API.

Example (cURL):

curl -X GET \
  \'https://api.baack.co/n/v1/companies\' \
  -H \'Bearer-Token: YOUR_API_KEY_HERE\'

Making Your First API Call

Once you have your API key, you're ready to make your first API call. We'll start with a simple GET request to retrieve a list of available companies. Endpoint

GET https://api.baack.co/n/v1/companies

Request Example

curl -X GET \
  \'https://api.baack.co/n/v1/companies\' \
  -H \'Beearer-Token: YOUR_API_KEY_HERE\'

Expected Response (JSON)

{
  "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
  "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
  "name" : "Example company name",
  "parentCompany" : {
    "urn" : "fe7f2716-3541-45d5-833d-b8a14ad386d0",
    "url" : "/n/v1/company/fe7f2716-3541-45d5-833d-b8a14ad386d0"
  },
  "owningCompany" : {
    "urn" : "7f8a5363-3a24-4ca1-a9a8-986bbbe7ee56",
    "url" : "/n/v1/company/7f8a5363-3a24-4ca1-a9a8-986bbbe7ee56"
  },
  "organisation" : {
    "urn" : "0225cc24-77fc-40fe-88dd-66f358a17d56",
    "url" : "/n/v1/organisation/0225cc24-77fc-40fe-88dd-66f358a17d56"
  }
}

Core capability functionality

The Baack APIs offer a wide range of capabilities to streamline your app development and power your products. This guide will briefly touch upon some key areas:

Identity Management

  • Create an identity: POST /v1/identity
  • Associate a name with a person: POST /v1/personname/
  • Update an address: PUT /v1/address/{address_id}
  • Delete an identity: DELETE /v1/identity/{identity_id}

Company management

  • Create a company: POST /n/v1/company/
  • Get a company: GET /n/v1/company/{company_id}
  • Update a company: PUT /n/v1/company/{company_id}
  • Delete a company: DELETE /n/v1/company/{company_id}
  • Query companies: GET /n/v1/companies

Next steps

  • Explore the API Reference: For detailed information on all available endpoints, request parameters, and response structures, refer to the official Baack API (reference documentation)[/doc/n/#reference].
  • Review SDKs: Coming soon
  • Join the Community: Coming soon.