Skip to content

About

Official php SDK for ShionStream API

Resources

Readme
Apache-2.0 license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository
BranchesTags

Repository files navigation

shionstream-client

Modular anime streaming and metadata API built with Hono on Cloudflare Workers.

For more information, please visit https://gox.my.id.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/shionstream/shionstream-php.git"
    }
  ],
  "require": {
    "shionstream/shionstream-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/shionstream-client/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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




$apiInstance = new ShionStreamClient\Api\AnimeApi(
    // 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()
);
$page = '1'; // string
$limit = '20'; // string
$search = 'search_example'; // string
$type = 'type_example'; // string
$status = 'status_example'; // string
$genre = 'genre_example'; // string
$season = 'season_example'; // string
$year = 'year_example'; // string
$sort = 'latest'; // string

try {
    $result = $apiInstance->v1AnimeGet($page, $limit, $search, $type, $status, $genre, $season, $year, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnimeApi->v1AnimeGet: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.gox.my.id

Class Method HTTP request Description
AnimeApi v1AnimeGet GET /v1/anime List Anime Catalog
AnimeApi v1AnimeSlugGet GET /v1/anime/{slug} Get Anime Details by Slug
CommentsApi v1CommentsGet GET /v1/comments Get Episode Comments
CommentsApi v1CommentsIdLikePost POST /v1/comments/{id}/like Like or Dislike Comment
CommentsApi v1CommentsIdReportPost POST /v1/comments/{id}/report Report Comment
CommentsApi v1CommentsPost POST /v1/comments Create Comment
DashboardApi v1DashboardAnimeGet GET /v1/dashboard/anime Get Administrative Anime List
DashboardApi v1DashboardCategoriesGet GET /v1/dashboard/categories Get Category & Genre Distributions
DashboardApi v1DashboardEpisodesGet GET /v1/dashboard/episodes Get Administrative Episodes List
DashboardApi v1DashboardModerationGet GET /v1/dashboard/moderation Get Comment Moderation Reports
DashboardApi v1DashboardModerationIdPatch PATCH /v1/dashboard/moderation/{id} Resolve or Dismiss Moderation Report
DashboardApi v1DashboardOverviewGet GET /v1/dashboard/overview Get Dashboard Overview
DashboardApi v1DashboardRolesGet GET /v1/dashboard/roles Get System Roles & Permissions
DashboardApi v1DashboardSeasonsGet GET /v1/dashboard/seasons Get Seasonal Broadcast Distributions
DashboardApi v1DashboardStatsGet GET /v1/dashboard/stats Get Platform Stats
DashboardApi v1DashboardUsersGet GET /v1/dashboard/users Get Users Directory (Admin Only)
EpisodesApi v1AnimeSlugEpisodesGet GET /v1/anime/{slug}/episodes List Episodes by Anime Slug
EpisodesApi v1EpisodesIdStreamGet GET /v1/episodes/{id}/stream Get Episode Stream Sources
SampleApi v1ProtectedSampleGet GET /v1/protected/sample Protected Sample Endpoint
SystemApi healthGet GET /health Health Check
UploadApi v1UploadHlsPost POST /v1/upload/hls Upload HLS Package to Cloudflare R2
UploadApi v1UploadImagePost POST /v1/upload/image Upload Image to Cloudflare R2
UserApi v1UserHistoryDelete DELETE /v1/user/history Clear All History
UserApi v1UserHistoryGet GET /v1/user/history Get Watch History
UserApi v1UserHistoryIdDelete DELETE /v1/user/history/{id} Delete History Item
UserApi v1UserHistoryPost POST /v1/user/history Record Playback Progress
UserApi v1UserProfileGet GET /v1/user/profile Get User Profile
UserApi v1UserSettingsGet GET /v1/user/settings Get User Settings
UserApi v1UserSettingsPatch PATCH /v1/user/settings Update User Settings
UserApi v1UserWatchlistAnimeIdDelete DELETE /v1/user/watchlist/{animeId} Remove from Watchlist
UserApi v1UserWatchlistAnimeIdPatch PATCH /v1/user/watchlist/{animeId} Update Watchlist Entry
UserApi v1UserWatchlistGet GET /v1/user/watchlist Get User Watchlist
UserApi v1UserWatchlistPost POST /v1/user/watchlist Add to Watchlist

Models

Authorization

Authentication schemes defined for the API:

Bearer

  • Type: Bearer authentication (JWT / API-Key)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

dev@gox.my.id

About this package

This PHP package is automatically generated for ShionStream API using OpenAPI specification:

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

About

Official php SDK for ShionStream API

Resources

Readme
Apache-2.0 license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages