Skip to content

feat(swift5): use Basic auth instead of Bearer #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

feat(swift5): use Basic auth instead of Bearer #82

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 44 additions & 62 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
<!--<documentation_excluded>-->
[![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video) &nbsp; [![badge](https://img.shields.io/github/stars/apivideo/api.video-android-uploader?style=social)](https://github.com/apivideo/api.video-android-uploader) &nbsp; [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video)
![](https://github.com/apivideo/.github/blob/main/assets/apivideo_banner.png)
<h1 align="center">api.video Android uploader</h1>

[api.video](https://api.video) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.

## Table of contents
# Table of contents

- [Table of contents](#table-of-contents)
- [Project description](#project-description)
- [Getting started](#getting-started)
- [Requirements](#requirements)
Expand All @@ -16,50 +14,34 @@
- [Gradle users](#gradle-users)
- [Others](#others)
- [Code sample](#code-sample)
- [Example](#example)
- [Upload methods](#upload-methods)
- [Upload options](#upload-options)
- [Permissions](#permissions)
- [Documentation](#documentation)
- [API Endpoints](#api-endpoints)
- [VideosApi](#videosapi)
- [Retrieve an instance of VideosApi:](#retrieve-an-instance-of-videosapi)
- [Endpoints](#endpoints)
- [Documentation for Models](#documentation-for-models)
- [Documentation for Authorization](#documentation-for-authorization)
- [Models](#models)
- [Authorization](#documentation-for-authorization)
- [API key](#api-key)
- [Public endpoints](#public-endpoints)
- [Recommendation](#recommendation)
- [Have you gotten use from this API client?](#have-you-gotten-use-from-this-api-client)
- [Have you gotten use from this API client?](#have-you-gotten-use-from-this-api-client-)
- [Contribution](#contribution)

<!--</documentation_excluded>-->
<!--<documentation_only>
---
title: api.video Android video uploader
meta:
description: The official api.video Android video uploader for api.video. [api.video](https://api.video/) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.
---

# api.video Android video uploader

[api.video](https://api.video/) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.

</documentation_only>-->
## Project description
# Project description

api.video's Android streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens.

## Getting started
# Getting started

### Requirements
## Requirements

Building the API client library requires:
1. Java 1.8+
2. Maven/Gradle

### Installation
## Installation

#### Maven users
### Maven users

Add this dependency to your project's POM:

Expand All @@ -72,15 +54,15 @@ Add this dependency to your project's POM:
</dependency>
```

#### Gradle users
### Gradle users

Add this dependency to your project's build file:

```groovy
implementation "video.api:android-video-uploader:1.3.2"
```

#### Others
### Others

At first generate the JAR by executing:

Expand All @@ -93,7 +75,7 @@ Then manually install the following JARs:
* `target/android-video-uploader-1.3.2.jar`
* `target/lib/*.jar`

### Code sample
## Code sample

Please follow the [installation](#installation) instruction and execute the following Kotlin code:

Expand All @@ -109,18 +91,18 @@ val workManager = WorkManager.getInstance(context) // WorkManager comes from pac
workManager.uploadWithUploadToken("MY_UPLOAD_TOKEN", myVideoFile) // Dispatch the upload with the WorkManager
```

#### Example
### Example

Examples that demonstrate how to use the API is provided in folder `examples/`.

### Upload methods
## Upload methods

To upload a video, you have 3 differents methods:
* `WorkManager`: preferred method: Upload with Android WorkManager API. It supports progress notifications, upload in background, queue, reupload after lost connections. Directly use, WorkManager extensions. See [example](https://github.com/apivideo/api.video-android-uploader/tree/main/examples/workmanager) for more details.
* `UploadService`: Upload with an Android Service. It supports progress notifications, upload in background, queue. You have to extend the `UploadService` and register it in your `AndroidManifest.xml`. See [examples/service](https://github.com/apivideo/api.video-android-uploader/tree/main/examples/service) for more details.
* `WorkManager`: preferred method: Upload with Android WorkManager API. It supports progress notifications, upload in background, queue, reupload after lost connections. Directly use, WorkManager extensions. See [example](examples/workmanager) for more details.
* `UploadService`: Upload with an Android Service. It supports progress notifications, upload in background, queue. You have to extend the `UploadService` and register it in your `AndroidManifest.xml`. See [example](examples/service) for more details.
* Direct call with `ApiClient`: Do not call API from the main thread, otherwise you will get an `android.os.NetworkOnMainThreadException`. Dispatch API calls with Thread, Executors or Kotlin coroutine to avoid this.

### Permissions
## Permissions

You have to add the following permissions in your `AndroidManifest.xml`:

Expand All @@ -132,51 +114,51 @@ You have to add the following permissions in your `AndroidManifest.xml`:

Your application also has to dynamically request the `android.permission.READ_EXTERNAL_STORAGE` permission to upload videos.

## Documentation
# Documentation

### API Endpoints
## API Endpoints

All URIs are relative to *https://ws.api.video*


#### VideosApi
### VideosApi


##### Retrieve an instance of VideosApi:
#### Retrieve an instance of VideosApi:
```kotlin
val videosApi = VideosApi("YOUR_API_KEY", Environment.PRODUCTION)
```



##### Endpoints
#### Endpoints

Method | HTTP request | Description
------------- | ------------- | -------------
[**upload**](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/VideosApi.md#upload) | **POST** /videos/{videoId}/source | Upload a video
[**uploadWithUploadToken**](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/VideosApi.md#uploadWithUploadToken) | **POST** /upload | Upload with an delegated upload token
[**upload**](docs/VideosApi.md#upload) | **POST** /videos/{videoId}/source | Upload a video
[**uploadWithUploadToken**](docs/VideosApi.md#uploadWithUploadToken) | **POST** /upload | Upload with an delegated upload token



### Documentation for Models
## Documentation for Models

- [AccessToken](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/AccessToken.md)
- [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/AdditionalBadRequestErrors.md)
- [AuthenticatePayload](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/AuthenticatePayload.md)
- [BadRequest](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/BadRequest.md)
- [Metadata](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/Metadata.md)
- [NotFound](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/NotFound.md)
- [RefreshTokenPayload](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/RefreshTokenPayload.md)
- [Video](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/Video.md)
- [VideoAssets](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/VideoAssets.md)
- [VideoSource](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/VideoSource.md)
- [VideoSourceLiveStream](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/VideoSourceLiveStream.md)
- [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/VideoSourceLiveStreamLink.md)
- [AccessToken](docs/AccessToken.md)
- [AdditionalBadRequestErrors](docs/AdditionalBadRequestErrors.md)
- [AuthenticatePayload](docs/AuthenticatePayload.md)
- [BadRequest](docs/BadRequest.md)
- [Metadata](docs/Metadata.md)
- [NotFound](docs/NotFound.md)
- [RefreshTokenPayload](docs/RefreshTokenPayload.md)
- [Video](docs/Video.md)
- [VideoAssets](docs/VideoAssets.md)
- [VideoSource](docs/VideoSource.md)
- [VideoSourceLiveStream](docs/VideoSourceLiveStream.md)
- [VideoSourceLiveStreamLink](docs/VideoSourceLiveStreamLink.md)


### Documentation for Authorization
## Documentation for Authorization

#### API key
### API key

Most endpoints required to be authenticated using the API key mechanism described in our [documentation](https://docs.api.video/reference#authentication).

Expand All @@ -185,24 +167,24 @@ Only the [Public endpoints](#public-endpoints) can be called without authenticat
In the case, you want to call an endpoint that requires authentication, you will have to use a backend server. See [Security best practices](https://docs.api.video/sdks/security) for more details.


#### Public endpoints
### Public endpoints

Some endpoints don't require authentication. These one can be called with a client instantiated without API key:
```kotlin
val videosApi = VideosApi()
```

### Recommendation
## Recommendation

It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
For direct call with `ApiClient`: Do not call API from the main thread, otherwise you will get a `android.os.NetworkOnMainThreadException`. Dispatch API calls with Thread, Executors or Kotlin coroutine to avoid this. Alternatively, APIs come with an asynchronous counterpart (`createAsync` for `create`) except for the upload endpoint.

### Have you gotten use from this API client?
## Have you gotten use from this API client?

Please take a moment to leave a star on the client ⭐

This helps other users to find the clients and also helps us understand which clients are most popular. Thank you!

## Contribution
# Contribution

Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, you can open a pull request on the repository of our [client generator](https://github.com/apivideo/api-client-generator). Otherwise, you can also simply open an issue detailing your need on this repository.