Skip to content

feat: Implement client-facing API for instance management#2

Open
mzhirnov1 wants to merge 1 commit intogreen-api:mainfrom
mzhirnov1:feat/client-api-endpoints
Open

feat: Implement client-facing API for instance management#2
mzhirnov1 wants to merge 1 commit intogreen-api:mainfrom
mzhirnov1:feat/client-api-endpoints

Conversation

@mzhirnov1
Copy link

This commit introduces a new client-facing API to manage GREEN-API instances, as per the frontend technical specification.

  • Adds a new ClientModule with a ClientController at /api/v1.
  • Implements two new endpoints:
    • POST /api/v1/client/status: Fetches the status of all instances for a Bitrix24 portal.
    • POST /api/v1/instance/create: Creates a new GREEN-API instance and returns a QR code for authorization.
  • Adds new methods to Bitrix24Service to support these endpoints, including getInstances, createInstance, and getAuthorizationData.
  • Includes placeholder logic for the external instance provisioning API and QR code generation, as the exact implementation details for these services were not available.
  • Adds DTOs for the new endpoints to ensure type safety.
  • Updates the main AppModule to include the new ClientModule.

This commit introduces a new client-facing API to manage GREEN-API instances, as per the frontend technical specification.

- Adds a new `ClientModule` with a `ClientController` at `/api/v1`.
- Implements two new endpoints:
  - `POST /api/v1/client/status`: Fetches the status of all instances for a Bitrix24 portal.
  - `POST /api/v1/instance/create`: Creates a new GREEN-API instance and returns a QR code for authorization.
- Adds new methods to `Bitrix24Service` to support these endpoints, including `getInstances`, `createInstance`, and `getAuthorizationData`.
- Includes placeholder logic for the external instance provisioning API and QR code generation, as the exact implementation details for these services were not available.
- Adds DTOs for the new endpoints to ensure type safety.
- Updates the main `AppModule` to include the new `ClientModule`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant