@ksimon/cue-connectors-web

Cue Connectors API Client

This repository contains the codebase for a specialized client application designed for interacting with the Cue Connectors API. The application is tailored for internal use, facilitating seamless integration and interaction with the Cue Connectors API to leverage its capabilities for our specific operational needs.

Features

• Authentication with Azure AD: Utilizes Azure Active Directory for secure authentication, ensuring that all interactions with the API are authenticated and authorized.
• Type-Safe API Requests: Implements type-safe request and response handling to interact with the Cue Connectors API, reducing runtime errors and enhancing developer experience.
• Product and Donation Management: Supports operations related to products and donations, including fetching product details, submitting orders, and processing donations.

Environment Setup

The application requires the following environment variables to be set for its operation:

• AZURE_AD_TENANT_ID: Your Azure Active Directory tenant ID.
• AZURE_AD_CLIENT_ID: The client ID of your Azure AD registered application.
• AZURE_AD_CLIENT_SECRET: The client secret for your Azure AD application.
• AZURE_AD_SCOPE: The scopes for which the application requests access.
• NEXT_PUBLIC_API_BASE_URL: The base URL for the Cue Connectors API.

Ensure these variables are configured in your environment to successfully use the application.

Usage

1. Authentication Setup: First, ensure that your Azure AD application is correctly configured and that you have the necessary tenant ID, client ID, client secret, and scope set up.

2. Environment Variables: Set up the required environment variables as per the above instructions.

3. Integration with Cue Connectors API: Utilize the provided functions and interfaces to interact with the Cue Connectors API. The application is pre-configured to handle various API endpoints, including those for product management and donation processing.

4. Making API Calls: Use the provided fetchAPI function to make API calls. This function abstracts away the complexity of making HTTP requests, including authentication handling and type-safe request and response processing.

Disclaimer

This application is specifically developed to work with the Cue Connectors API and may not be suitable for other purposes. It is intended for internal use and is not designed for public release or external use.