Skip to content

Repository files navigation

cielo24

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:

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

Getting Started

Please follow the installation procedure and then run the following:

<?phprequire_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 = newCielo24\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.newGuzzleHttp\Client(),
$config
);
$v = 1; // inttry {
$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

ClassMethodHTTP requestDescription
AccountApigetSettingsGET /account/get_settings
AccountApiloginPOST /account/login
AccountApilogoutPOST /account/logout
AccountApiverifyKeyGET /account/verify_key
JobApiaddMediaFilePOST /job/add_media
JobApiaddMediaUrlGET /job/add_media
JobApiauthorizeJobPOST /job/authorize
JobApigetCaptionGET /job/get_caption
JobApijobInfoGET /job/info
JobApinewJobPOST /job/new
JobApiperformTranscriptionPOST /job/perform_transcription
JobApiperformTranslationPOST /job/translate

Models

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

devs@cielo24.com

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

About

cielo24 PHP API Library based on OpenAPI specs

Resources

Stars

1 star

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages