cielo24

Cielo24

• API version: 1.0.0
  • Build date: 2022-06-23T14:23:37.760-03:00[America/Sao_Paulo]

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.

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>org.openapitools</groupId>
  <artifactId>cielo24</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'cielo24' jar has been published to maven central.
    mavenLocal()       // Needed if the 'cielo24' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "org.openapitools:cielo24:1.0.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/cielo24-1.0.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.ApiClient;
import com.ApiException;
import com.Configuration;
import com.auth.*;
import com.models.*;
import com.cielo24.AccountApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.cielo24.com/api");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    AccountApi apiInstance = new AccountApi(defaultClient);
    Integer v = 1; // Integer | 
    try {
      Object result = apiInstance.getSettings(v);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccountApi#getSettings");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for 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

Documentation for Models

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

Documentation for Authorization

Authentication schemes defined for the API:

ApiKeyAuth

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

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]