API Connectors in Brightsy AI are integrations with external APIs and services registered using OpenAPI 3.0+ specifications. This guide will help you navigate and use the form to create or update API connectors within the Brightsy platform.
Accessing the Form
To access the form, navigate to the "API Connectors" section of your account dashboard. You can either create a new API connector or edit an existing one.
Form Overview
The form is designed to capture essential details about your API connector, including its name, description, status, and OpenAPI definition.
API Connector Properties
| Property | Type | Description | Required | Constraints |
|---|---|---|---|---|
| id | string | Unique identifier for the API connector | Auto-generated | Read-only |
| name | string | Name of the API connector | Yes | 2-50 characters |
| description | string | Description of the API connector's purpose | Yes | Max 5000 characters |
| status | enum | Current state of the API connector | Yes | Values: "disabled", "enabled" |
| openApiDefinition | object | OpenAPI 3.0+ definition in JSON format | Yes | Valid OpenAPI 3.0+ schema |
| createdAt | datetime | When the API connector was created | Auto-generated | Read-only |
| updatedAt | datetime | When the API connector was last updated | Auto-generated | Read-only |
Form Fields
Name
- Purpose: Enter the name of your API connector.
- Requirements: The name must be between 2 and 50 characters long.
Description
- Purpose: Provide a brief description of your API connector's purpose.
- Requirements: The description can be up to 5000 characters long.
Status
- Purpose: Set the current state of your API connector.
- Options:
- Disabled: The application is not active.
- Enabled: The application is active and operational.
OpenAPI 3.0+ Definition
- Purpose: Upload a JSON file containing the OpenAPI 3.0+ definition for your application.
- Supported Security Schemes: The only supported security schemes are API Key and HTTP Authentication (including Basic and Bearer).
- How to Use:
- Click "Upload JSON File" to select and upload your file.
- If a file is uploaded, you can download it by clicking "Download JSON."
- If your application has an ID, you can view its documentation by clicking "View Docs."
Error Handling
If an error occurs while saving your application, an alert will be displayed at the top of the form. Please review your inputs and try again.
Actions
- Save: Click this button to save your application details. If successful, you will be redirected to the applications list.
- Cancel: Click this button to exit the form without saving any changes.
Additional Features
- Danger Zone: If you are editing an existing application, additional options may be available in the "Danger Zone" for actions like deleting the application.
Tips for Success
- Ensure all required fields are filled out correctly before submitting the form.
- Double-check your JSON file for correct formatting to avoid errors.
- Use the "Cancel" button if you need to exit without saving changes.