This API is for async event communication
This Symfony bundle is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.5
- Build package: org.openapitools.codegen.languages.PhpSymfonyServerCodegen
PHP 8.0 and later
To install the dependencies via Composer, add the following repository to composer.json
of your Symfony project:
{
"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.
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
Step 1: Please follow the installation procedure first.
Step 2: Enable the bundle in the bundle configuration:
// app/config/bundles.php
return [
// ...
Qu\LaInternalApiServer\LiveAgentInternalApiServerBundle::class => ['all' => true],
];
Step 3: Register the routes:
# app/config/routes.yaml
live_agent_internal_api_server:
resource: "@LiveAgentInternalApiServerBundle/Resources/config/routing.yaml"
Step 4: Implement the API calls:
<?php
// src/Acme/MyBundle/Api/EventsApiInterface.php
namespace Acme\MyBundle\Api;
use Qu\LaInternalApiServer\Api\EventsApiInterface;
class EventsApi implements EventsApiInterface // An interface is autogenerated
{
// Other operation methods ...
}
Step 5: Tag your API implementation:
# config/services.yaml
services:
# ...
Acme\MyBundle\Api\EventsApi:
tags:
- { name: "live_agent_internal_api_server.api", api: "events" }
# ...
Now you can start using the bundle!
All URIs are relative to http://localhost/public/api/internal
Class | Method | HTTP request | Description |
---|---|---|---|
EventsApiInterface | executeHandler | POST /handlers | Execute event handlers |
EventsApiInterface | getEventConsumers | GET /handlers | Get event consumer definitions |
- Type: HTTP basic authentication