Skip to content
No description, website, or topics provided.
PHP
Branch: master
Clone or download
Latest commit 28ad089 Aug 8, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Release 1.2.0 Aug 8, 2019
lib Release 1.2.0 Aug 8, 2019
test Release 1.2.0 Aug 8, 2019
.gitignore Release 1.0.72 Feb 20, 2019
.travis.yml Add sdk Mar 21, 2017
LICENSE Add sdk Mar 21, 2017
README.md Release 1.1.2 Aug 1, 2019
autoload.php Release 1.2.0 Aug 8, 2019
composer.json Release 1.0.67 Dec 20, 2018

README.md

Kaemo PHP SDK Documentation

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

Method 1:

To install the bindings via Composer, type in your console: composer require kinow-io/kaemo-php-sdk

Method 2:

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

{
    "repositories": [{
        "type": "git",
        "url": "https://github.com/kinow-io/kinow-php-sdk.git"
    }],
    "require": {
        "kinow-io/kinow-php-sdk": "^1.0"
    }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/KaemoClient/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

$api_instance = new Kaemo\Client\Api\AccessesApi();
$category_id = 789; // int | Category ID to fetch
$customer_id = 789; // int | 

try {
    $result = $api_instance->getAvailableCategory($category_id, $customer_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccessesApi->getAvailableCategory: ', $e->getMessage(), PHP_EOL;
}

?>

Enable Debug Logs

You can enable debug logging to get information about what is sent or received by the SDK. The logs will be available in the 'output' file at the root of your server.

When submitting a support request, it is best to provide the logs file for a faster resolution of your issue.

// To be done before doing anything with the SDK
// Activate debug logs
Kaemo\Client\Configuration::getDefaultConfiguration()->setDebug(true);

// (optionally) Change debug file location (default is 'php://output')
Kaemo\Client\Configuration::getDefaultConfiguration()->setDebugFile('php://output');

Documentation for API Endpoints

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

Class Method HTTP request Description
AccessesApi getAvailableCategory GET /categories-accesses/{category_id}
AccessesApi getCustomerHasAccessToProduct GET /customers/{customer_id}/products/{product_id}/has-access
AccessesApi getCustomerHasAccessToVideo GET /customers/{customer_id}/videos/{video_id}/has-access
AccessesApi getProductAvailability GET /products/{product_id}/access
ActorsApi createActor POST /actors
ActorsApi deleteActor DELETE /actors/{actor_id}
ActorsApi getActor GET /actors/{actor_id}
ActorsApi getActors GET /actors
ActorsApi getProductActors GET /products/{product_id}/actors
ActorsApi updateActor PUT /actors/{actor_id}
AddressApi getCustomerAddress GET /customers/{customer_id}/address
AddressApi updateAddress PUT /addresses/{address_id}
AttributesApi createProductAttribute POST /attributes
AttributesApi getProductAttributes GET /products/{product_id}/attributes
AttributesApi updateProductAttribute PUT /attributes/{attribute_id}
BlogCategoriesApi getBlogCategories GET /blog-categories
BlogCategoriesApi getBlogCategory GET /blog-categories/{blog_category_id}
BlogPagesApi getBlogPage GET /blog-pages/{blog_page_id}
BlogPagesApi getBlogPages GET /blog-pages
BookmarksApi attachBookmarkToCustomer POST /customers/{customer_id}/bookmarks
BookmarksApi detachBookmarkFromCustomer DELETE /customers/{customer_id}/bookmarks/{product_id}
BookmarksApi getCustomerBookmarks GET /customers/{customer_id}/bookmarks
CMSCategoriesApi createCMSCategory POST /cms-categories
CMSCategoriesApi getCMSCategories GET /cms-categories
CMSCategoriesApi updateCMSCategory PUT /cms-categories/{cms_category_id}
CMSPagesApi createCMSPage POST /cms-pages
CMSPagesApi getCMSPages GET /cms-pages
CMSPagesApi updateCMSPage PUT /cms-pages/{cms_page_id}
CartRulesApi attachCartRuleToCart POST /carts/{cart_id}/cart-rules
CartRulesApi createCartRule POST /cart-rules
CartRulesApi deleteCartRule DELETE /cart-rules/{cart_rule_id}
CartRulesApi getCartRule GET /cart-rules/{cart_rule_id}
CartRulesApi getCartRules GET /cart-rules
CartRulesApi updateCartRule PUT /cart-rules/{cart_rule_id}
CartsApi addProductToCart POST /carts/{cart_id}/products
CartsApi attachCartRuleToCart POST /carts/{cart_id}/cart-rules
CartsApi attachCartToCustomer POST /customers/{customer_id}/carts
CartsApi createCart POST /carts
CartsApi deleteCart DELETE /carts/{cart_id}
CartsApi deleteProductFromCart DELETE /carts/{cart_id}/products
CartsApi getCart GET /carts/{cart_id}
CartsApi getCustomerCarts GET /customers/{customer_id}/carts
CartsApi getLastCart GET /customers/{customer_id}/last-cart
CartsApi getPaymentUrl GET /carts/{cart_id}/payments/{payment_name}
CartsApi updateCart PUT /carts/{cart_id}
CartsApi validateCart POST /carts/{cart_id}/payments/{payment_name}/validate
CartsApi validateFreeOrder POST /carts/{cart_id}/validate-free-order
CategoriesApi createCategory POST /categories
CategoriesApi getAvailableCategory GET /categories-accesses/{category_id}
CategoriesApi getCategories GET /categories
CategoriesApi getCategoriesFromCategory GET /categories/{category_id}/categories
CategoriesApi getCategory GET /categories/{category_id}
CategoriesApi getCategoryBanner GET /categories/{category_id}/banner
CategoriesApi getCategoryFeatures GET /categories/{category_id}/features
CategoriesApi getCategoryProducts GET /categories/{category_id}/products
CategoriesApi getProductCategories GET /products/{product_id}/categories
CategoriesApi getSubscriptionCategories GET /subscriptions/{subscription_id}/categories
CountriesApi getCountries GET /countries
CurrenciesApi getCurrencies GET /currencies
CustomerThreadsApi getCustomerThread GET /customer-threads/{customer_thread_id}
CustomerThreadsApi getCustomerThreads GET /customer-threads
CustomersApi attachCartToCustomer POST /customers/{customer_id}/carts
CustomersApi checkCustomerCredentials POST /customers/check-credentials
CustomersApi createCustomer POST /customers
CustomersApi createFacebookId POST /customers/facebook
CustomersApi deleteCustomer DELETE /customers/{customer_id}
CustomersApi generateAuthenticationToken GET /customers/{customer_id}/authentication-token
CustomersApi getCustomer GET /customers/{customer_id}
CustomersApi getCustomerAccessesSubscriptions GET /customers/{customer_id}/accesses/subscriptions
CustomersApi getCustomerAccessesVideos GET /customers/{customer_id}/accesses/videos
CustomersApi getCustomerAddress GET /customers/{customer_id}/address
CustomersApi getCustomerCanSeeProduct GET /customers/{customer_id}/products/{product_id}/can-see
CustomersApi getCustomerCurrentViews GET /customers/{customer_id}/current-views
CustomersApi getCustomerGroups GET /customers/{customer_id}/groups
CustomersApi getCustomerHasAccessToProduct GET /customers/{customer_id}/products/{product_id}/has-access
CustomersApi getCustomerHasAccessToVideo GET /customers/{customer_id}/videos/{video_id}/has-access
CustomersApi getCustomerOrders GET /customers/{customer_id}/orders
CustomersApi getCustomers GET /customers
CustomersApi getFacebookCustomer GET /customers/facebook/{facebook_id}
CustomersApi getPaymentCustomerId GET /customers/{customer_id}/payments/{payment_name}/customer
CustomersApi updateCustomer PUT /customers/{customer_id}
DirectorsApi createDirector POST /directors
DirectorsApi deleteDirector DELETE /directors/{director_id}
DirectorsApi getDirector GET /directors/{director_id}
DirectorsApi getDirectors GET /directors
DirectorsApi getProductDirectors GET /products/{product_id}/directors
DirectorsApi updateDirector PUT /directors/{director_id}
ExtractsApi attachCoverToExtract POST /extracts/{extract_id}/cover
ExtractsApi createExtract POST /extracts
ExtractsApi deleteExtract DELETE /extracts/{extract_id}
ExtractsApi getExtractPlayer GET /extracts/{extract_id}/player
ExtractsApi getProductExtracts GET /products/{product_id}/extracts
ExtractsApi updateExtract PUT /extracts/{extract_id}
FeatureValuesApi attachFeaturesToProduct POST /products/{product_id}/features
FeatureValuesApi attachFeaturesToVideo POST /videos/{video_id}/features
FeatureValuesApi detachFeatureToProduct DELETE /products/{product_id}/features/{feature_id}
FeatureValuesApi getFeatureValues GET /feature-values
FeaturesApi attachFeaturesToProduct POST /products/{product_id}/features
FeaturesApi attachFeaturesToVideo POST /videos/{video_id}/features
FeaturesApi detachFeatureToProduct DELETE /products/{product_id}/features/{feature_id}
FeaturesApi getCategoryFeatures GET /categories/{category_id}/features
FeaturesApi getFeatureValues GET /feature-values
FeaturesApi getFeatures GET /features
FeaturesApi getProductFeatures GET /products/{product_id}/features
FeaturesApi getVideoFeatures GET /videos/{video_id}/features
GendersApi getGenders GET /genders
GeolocationsApi geolocations POST /geolocations
GeolocationsApi getProductGeolocations GET /products/{product_id}/geolocations
GeolocationsApi getProductGeolocationsByIp POST /products/{product_id}/geolocations
GeolocationsApi getVideoGeolocationByIp POST /videos/{video_id}/geolocations/{ip_address}
GeolocationsApi setProductGeolocation PUT /products/{product_id}/geolocations
GeolocationsApi setVideoGeolocation PUT /videos/{video_id}/geolocations
GroupsApi attachCustomerToGroup POST /groups/{group_id}/customers
GroupsApi detachCustomerFromGroup DELETE /groups/{group_id}/customers/{customer_id}
GroupsApi getGroup GET /groups/{group_id}
GroupsApi getGroups GET /groups
GroupsApi getProductGroups GET /products/{product_id}/groups
ImagesApi deleteProductScreenshot DELETE /products/{product_id}/screenshots/{image_id}
ImagesApi getActorCoverImage GET /actors/{actor_id}/cover
ImagesApi getCategoryBanner GET /categories/{category_id}/banner
ImagesApi getDirectorCoverImage GET /directors/{director_id}/cover
ImagesApi getIntroImage GET /widgets/intro/images
ImagesApi getProductCoverImage GET /products/{product_id}/cover
ImagesApi getProductImages GET /products/{product_id}/images
ImagesApi getProductScreenshots GET /products/{product_id}/screenshots
ImagesApi getSubscriptionCoverImage GET /subscriptions/{subscription_id}/cover
ImagesApi getVideoCover GET /videos/{video_id}/cover
ImagesApi uploadActorCover POST /actors/{actor_id}/cover
ImagesApi uploadCategoryBanner POST /category/{category_id}/banner
ImagesApi uploadDirectorCover POST /directors/{director_id}/cover
ImagesApi uploadProductCover POST /products/{product_id}/cover
ImagesApi uploadProductScreenshot PUT /products/{product_id}/screenshots/{image_id}
ImagesApi uploadProductScreenshots POST /products/{product_id}/screenshots
ImagesApi uploadSubscriptionCover POST /subscriptions/{subscription_id}/cover
LanguagesApi getLanguages GET /languages
MediaFilesApi getMediaSourceFiles GET /media-sources/{source_id}/files
MediaFilesApi postMediaSourceFiles POST /media-sources/{source_id}/files
MediaSourcesApi getMediaSource GET /media-sources/{source_id}
MediaSourcesApi getMediaSourceFiles GET /media-sources/{source_id}/files
MediaSourcesApi getMediaSources GET /media-sources
MediaSourcesApi postMediaSourceFiles POST /media-sources/{source_id}/files
OAuthApi getToken POST /get-token
OrderHistoriesApi getOrderHistories GET /orders/{order_id}/histories
OrderStatesApi getOrderState GET /order-states/{order_state_id}
OrderStatesApi getOrderStates GET /order-states
OrdersApi getCustomerOrders GET /customers/{customer_id}/orders
OrdersApi getOrder GET /orders/{order_id}
OrdersApi getOrderHistories GET /orders/{order_id}/histories
OrdersApi getOrderInvoice GET /orders/{order_id}/invoice
OrdersApi getOrders GET /orders
PaymentModulesApi getPaymentModules GET /payment-modules
PaymentModulesApi getPaymentUrl GET /carts/{cart_id}/payments/{payment_name}
PaymentModulesApi validateCart POST /carts/{cart_id}/payments/{payment_name}/validate
PaymentModulesApi validateFreeOrder POST /carts/{cart_id}/validate-free-order
ProductAccessesApi createProductAccess POST /product-accesses
ProductAccessesApi deleteProductAccess DELETE /product-accesses/{product_access_id}
ProductAccessesApi getCustomerAccessesSubscriptions GET /customers/{customer_id}/accesses/subscriptions
ProductAccessesApi getCustomerAccessesVideos GET /customers/{customer_id}/accesses/videos
ProductAccessesApi getProductAccess GET /product-accesses/{product_access_id}
ProductAccessesApi getProductAccesses GET /product-accesses
ProductAccessesApi stopSubscription PUT /customers/{customer_id}/unsubscribe
ProductAccessesApi updateProductAccess PUT /product-accesses/{product_access_id}
ProductsApi attachFeaturesToProduct POST /products/{product_id}/features
ProductsApi attachProductToActor POST /products/{product_id}/actors
ProductsApi attachProductToCategory POST /products/{product_id}/categories
ProductsApi attachProductToDirector POST /products/{product_id}/directors
ProductsApi attachProductToGroup POST /products/{product_id}/groups
ProductsApi attachVideoToProduct POST /products/{product_id}/videos
ProductsApi createProduct POST /products
ProductsApi deleteProduct DELETE /products/{product_id}
ProductsApi detachFeatureToProduct DELETE /products/{product_id}/features/{feature_id}
ProductsApi detachProductFromActor DELETE /products/{product_id}/actors/{actor_id}
ProductsApi detachProductFromCategory DELETE /products/{product_id}/categories/{category_id}
ProductsApi detachProductFromDirector DELETE /products/{product_id}/directors/{director_id}
ProductsApi detachProductFromGroup DELETE /products/{product_id}/groups/{group_id}
ProductsApi getCategoryProducts GET /categories/{category_id}/products
ProductsApi getCustomerHasAccessToProduct GET /customers/{customer_id}/products/{product_id}/has-access
ProductsApi getProduct GET /products/{product_id}
ProductsApi getProductActors GET /products/{product_id}/actors
ProductsApi getProductAttributes GET /products/{product_id}/attributes
ProductsApi getProductAvailability GET /products/{product_id}/access
ProductsApi getProductCategories GET /products/{product_id}/categories
ProductsApi getProductCoverImage GET /products/{product_id}/cover
ProductsApi getProductDirectors GET /products/{product_id}/directors
ProductsApi getProductExtracts GET /products/{product_id}/extracts
ProductsApi getProductFeatures GET /products/{product_id}/features
ProductsApi getProductGeolocations GET /products/{product_id}/geolocations
ProductsApi getProductGeolocationsByIp POST /products/{product_id}/geolocations
ProductsApi getProductGroups GET /products/{product_id}/groups
ProductsApi getProductImages GET /products/{product_id}/images
ProductsApi getProducts GET /products
ProductsApi getProductsFromProduct GET /products/{product_id}/products
ProductsApi getVideosFromProduct GET /products/{product_id}/videos
ProductsApi searchProducts GET /products/search/{search_query}
ProductsApi setProductGeolocation PUT /products/{product_id}/geolocations
ProductsApi updateProduct PUT /products/{product_id}
ProductsApi updateProductGroupRestrictionBehavior PUT /products/{product_id}/groups/behavior
StatsApi getCustomerGroupTotalWatched GET /video-stats/customer-group
StatsApi getCustomerSessions GET /video-stats/sessions
StatsApi getCustomerVideoStats GET /video-stats/customers
StatsApi getVideoStats GET /video-stats/videos
SubscriptionsApi getDisabledSubscriptions GET /videos/{video_id}/disabled-subscriptions
SubscriptionsApi getSubscription GET /subscriptions/{subscription_id}
SubscriptionsApi getSubscriptionCategories GET /subscriptions/{subscription_id}/categories
SubscriptionsApi getSubscriptionCoverImage GET /subscriptions/{subscription_id}/cover
SubscriptionsApi getSubscriptions GET /subscriptions
TasksApi createTask POST /tasks
VideosApi attachCoverToVideo POST /videos/{video_id}/cover
VideosApi attachFeaturesToVideo POST /videos/{video_id}/features
VideosApi attachVideoToProduct POST /products/{product_id}/videos
VideosApi createVideo POST /videos
VideosApi deleteVideo DELETE /videos/{video_id}
VideosApi getCustomerHasAccessToVideo GET /customers/{customer_id}/videos/{video_id}/has-access
VideosApi getDisabledSubscriptions GET /videos/{video_id}/disabled-subscriptions
VideosApi getVideo GET /videos/{video_id}
VideosApi getVideoAccess GET /videos/{video_id}/customers/{customer_id}/access
VideosApi getVideoBonus GET /videos/{video_id}/bonus
VideosApi getVideoDownloadUrl GET /videos/{video_id}/download-url
VideosApi getVideoFeatures GET /videos/{video_id}/features
VideosApi getVideoGeolocation GET /videos/{video_id}/geolocation
VideosApi getVideoGeolocationByIp POST /videos/{video_id}/geolocations/{ip_address}
VideosApi getVideoPlayer GET /videos/{video_id}/player
VideosApi getVideoSubtitles GET /videos/{video_id}/subtitles
VideosApi getVideoViews GET /videos/{video_id}/views
VideosApi getVideos GET /videos
VideosApi getVideosFromProduct GET /products/{product_id}/videos
VideosApi setVideoGeolocation PUT /videos/{video_id}/geolocations
VideosApi updateVideo PUT /videos/{video_id}
WidgetsApi getIntroImage GET /widgets/intro/images
WidgetsApi getWidgetFooterMenu GET /widgets/footer-menu
WidgetsApi getWidgetSlider GET /widgets/slider
WidgetsApi getWidgetSliderItem GET /widgets/slider/{slider_id}
WidgetsApi getWidgetTopMenu GET /widgets/top-menu

Documentation For Models

You can’t perform that action at this time.