utreon/cielo24-php

The cielo24 Web Services Platform API allows developers to easily integrate transcription, captioning and keyword extraction into their applications without having to use a manual web portal.

dev-master 2022-07-07 08:40 UTC

Requires

• php: ^7.4 || ^8.0
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^7.3
• guzzlehttp/psr7: ^1.7 || ^2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.5
• phpunit/phpunit: ^8.0 || ^9.0

MIT

• OpenAPI-Generator contributors

• php
• rest
• api
• sdk
• openapi
• openapitools
• openapi-generator

README

The cielo24 Web Services Platform API allows developers to easily integrate transcription, captioning and keyword extraction into their applications without having to use a manual web portal.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, run following command:

composer require utreon/cielo24-php 

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/cielo24/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: ApiKeyAuth
$config = Cielo24\Configuration::getDefaultConfiguration()->setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Cielo24\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_token', 'Bearer');


$apiInstance = new Cielo24\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$v = 1; // int

try {
    $result = $apiInstance->getSettings($v);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getSettings: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.cielo24.com/api

Class	Method	HTTP request	Description
AccountApi	getSettings	GET /account/get_settings
AccountApi	login	POST /account/login
AccountApi	logout	POST /account/logout
AccountApi	verifyKey	GET /account/verify_key
JobApi	addMediaFile	POST /job/add_media
JobApi	addMediaUrl	GET /job/add_media
JobApi	authorizeJob	POST /job/authorize
JobApi	getCaption	GET /job/get_caption
JobApi	jobInfo	GET /job/info
JobApi	newJob	POST /job/new
JobApi	performTranscription	POST /job/perform_transcription
JobApi	performTranslation	POST /job/translate

Models

• AddMediaResponse
• ErrorResponse
• IWPEnum
• JobInfoResponse
• JobOptions
• LoginBody
• LoginResponse
• NewJobBody
• NewJobResponse
• PerformTranscriptionBody
• PerformTranscriptionResponse
• PerformTranslationResponse
• VerifyKeyResponse

Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: api_token
• Location: URL query string

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

[e-mail]

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen