https://github.com/qualityunit/liveagent-internal-api-server
https://github.com/qualityunit/liveagent-internal-api-server
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/qualityunit/liveagent-internal-api-server
- Owner: QualityUnit
- Created: 2023-03-17T14:17:19.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-11T20:50:54.000Z (about 2 years ago)
- Last Synced: 2025-12-31T13:30:29.826Z (6 months ago)
- Language: PHP
- Size: 102 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LiveAgentInternalApiServer
This API is for async event communication
This [Symfony](https://symfony.com/) bundle is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
- Package version: 1.0.5
- Build package: org.openapitools.codegen.languages.PhpSymfonyServerCodegen
## Requirements
PHP 8.0 and later
## Installation & Usage
To install the dependencies via [Composer](http://getcomposer.org/), add the following repository to `composer.json` of your Symfony project:
```json
{
"repositories": [{
"type": "path",
"url": "//Path to your generated openapi bundle"
}],
}
```
Then run:
```
composer require qualityunit/liveagent-internal-api-server:dev-master
```
to add the generated openapi bundle as a dependency.
## Tests
To run the unit tests for the generated bundle, first navigate to the directory containing the code, then run the following commands:
```
composer install
./vendor/bin/phpunit
```
## Getting Started
Step 1: Please follow the [installation procedure](#installation--usage) first.
Step 2: Enable the bundle in the bundle configuration:
```php
// app/config/bundles.php
return [
// ...
Qu\LaInternalApiServer\LiveAgentInternalApiServerBundle::class => ['all' => true],
];
```
Step 3: Register the routes:
```yaml
# app/config/routes.yaml
live_agent_internal_api_server:
resource: "@LiveAgentInternalApiServerBundle/Resources/config/routing.yaml"
```
Step 4: Implement the API calls:
```php