bploeger/picthrive

Detailed docs about our API, including hidden fields not publicly displayed.

Maintainers

Details

github.com/bploeger/picthriveAPIbeta

Homepage

Source

Issues

Installs: 15

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

dev-master 2019-05-08 17:31 UTC

Requires

Requires (Dev)

proprietary 442e110c3fe7858a12ff543fd2a7170f3425f4bf

phprestapisdkopenapitoolsopenapi-generator

This package is auto-updated.

Last update: 2024-06-09 05:07:45 UTC

README

Detailed docs about our API.

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install run composer require "bploeger/picthrive"

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new OpenAPI\Client\Api\BrandApi(
    // 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(),
    $config
);
$brand_id = 'brand_id_example'; // string | The unique ID of the Brand

try {
    $result = $apiInstance->getStore($brand_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrandApi->getStore: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.picthrive.com/v1

Class Method HTTP request Description
BrandApi getStore GET /Brand/{brandId} Get Store
BrandApi listStores GET /Brand/ Get all Stores
GroupApi createGroup POST /Group/ Create an new Group.
GroupApi createUploadPhotoRequest POST /Group/{groupId}/Photo Upload a photo
GroupApi deleteGroup DELETE /Group/{groupId} Delete the Group
GroupApi getGroup GET /Group/{groupId} Gets a Group.
GroupApi listGroupPhotos GET /Group/{groupId}/Photo List photos
GroupApi listGroupVideos GET /Group/{groupId}/Video List videos
GroupApi listGroups GET /Group/ List Groups
GroupApi markGroupAsUploading PUT /Group/{groupId}/UploadStatus Update Upload Status
GroupApi searchForGroupByToken GET /Group/Search Search for Group by Token
GroupApi updateGroup PUT /Group/{groupId} Update a Group
GroupApi zipGroupPhotos POST /Group/{groupId}/Zip Zip Photos
OwnerApi getAccount GET /Owner/ Get Your Account
PhotoApi createUploadPhotoRequest POST /Group/{groupId}/Photo Upload a photo
PhotoApi deletePhoto DELETE /Photo/{photoId} Delete a Photo
PhotoApi getPhoto GET /Photo/{photoId} Get a Photo
PhotoApi listGroupPhotos GET /Group/{groupId}/Photo List photos
PhotoApi markGroupAsUploading PUT /Group/{groupId}/UploadStatus Update Upload Status
PhotoApi updatePhoto PUT /Photo/{photoId} Copy or Move a Photo
PhotoApi zipGroupPhotos POST /Group/{groupId}/Zip Zip Photos
VideoApi listGroupVideos GET /Group/{groupId}/Video List videos
VideoApi markGroupAsUploading PUT /Group/{groupId}/UploadStatus Update Upload Status

Documentation For Models

Documentation For Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author