cielo24

cielo24 - the Ruby gem for the 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.

This SDK is automatically generated by the OpenAPI Generator project:

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

Installation

Build a gem

To build the Ruby code into a gem:

gem build cielo24.gemspec

Then either install the gem locally:

gem install ./cielo24-1.0.0.gem

(for development, run gem install --dev ./cielo24-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'cielo24', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/cielo24/cielo24-python, then add the following in the Gemfile:

gem 'cielo24', :git => 'https://github.com/cielo24/cielo24-python.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gemrequire'cielo24'# Setup authorizationcielo24.configuredo |config|
# Configure API key authorization: ApiKeyAuthconfig.api_key['ApiKeyAuth']='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'endapi_instance=cielo24::AccountApi.newv=56# Integer | beginresult=api_instance.get_settings(v)presultrescuecielo24::ApiError=>eputs"Exception when calling AccountApi->get_settings: #{e}"end

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
cielo24::AccountApi	get_settings	GET /account/get_settings
cielo24::AccountApi	login	POST /account/login
cielo24::AccountApi	logout	POST /account/logout
cielo24::AccountApi	verify_key	GET /account/verify_key
cielo24::JobApi	add_media_file	POST /job/add_media
cielo24::JobApi	add_media_url	GET /job/add_media
cielo24::JobApi	authorize_job	POST /job/authorize
cielo24::JobApi	get_caption	GET /job/get_caption
cielo24::JobApi	job_info	GET /job/info
cielo24::JobApi	new_job	POST /job/new
cielo24::JobApi	perform_transcription	POST /job/perform_transcription
cielo24::JobApi	perform_translation	POST /job/translate

Documentation for Models

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

Documentation for Authorization

ApiKeyAuth

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