Getting Started with BrigitAPI

Welcome to the BrigitAPI! This guide will help you get started with using our RESTful API. The BrigitAPI is language-agnostic and can be integrated into various applications regardless of the programming language. Follow the steps below to begin using the API.

API Documentation

  • Static API Documentation: You are currently viewing the static documentation for the BrigitAPI. This documentation provides detailed information on the API endpoints, request/response formats, and authentication methods. We do have language specific tutorials available further down in this document.
  • Interactive API Documentation (Swagger UI): Swagger UI

Authentication

To use the API, you need an API user account. Please contact us at info@brigitsoftware.nl to request your API user credentials.

BrigitAPI uses Basic Authentication. For detailed information on how to authenticate, see the Generic Tutorial below.

API Access

The API can be accessed via the following URL:

Integration

Several standard integrations are being built on this API, such as:

  • Syntess
  • Robaws

For more information on these integrations, please contact us at info@brigitsoftware.nl.

Using the API

The BrigitAPI adheres to Richardson Maturity Level 2 and follows best practices for REST APIs. It also uses Swagger UI to generate a user-friendly interface for exploring and testing API calls. The API generates an OpenAPI 3.0 specification upon deployment to ensure the documentation matches the actual API.

Generic Tutorial

This API is language-agnostic and can be used in many programming languages. Here's a generic guide to help you get started:

  1. Obtain API Credentials:

  2. Authenticate:

    • Use Basic Authentication to secure your API calls. Combine your username and password in the format username:password, then encode this string using Base64. Include the encoded string in the Authorization header of your HTTP requests as follows: Authorization: Basic <encoded_credentials>.

  3. Explore the API:

    • Use the Swagger UI to explore the available endpoints and test API calls interactively.

  4. Make API Requests:

    • Prepare your HTTP client to make requests to the API. Ensure you include the Authorization header in each request.

Example Workflow

  1. Combine Credentials:

    • Combine your username and password: your-username:your-password.

  2. Base64 Encode:

    • Encode the combined string using Base64.

  3. Set Authorization Header:

    • Create the Authorization header: Authorization: Basic <encoded_credentials>.

  4. Send API Requests:

    • Use your HTTP client to send requests to the API, including the Authorization header in each request.

Language-Specific Tutorials

Currently, we provide language-specific tutorials for:

For other languages, follow the generic tutorial provided above. If you need further assistance, please refer to the API documentation or contact our support team.

Contact Us

For any questions or further assistance, feel free to reach out to us at info@brigitsoftware.nl.

By following this guide, you should be able to quickly and effectively start using the BrigitAPI in your applications.