https://github.com/austinkregel/tamber-php-sdk
A PHP SDK for the Tamber API
https://github.com/austinkregel/tamber-php-sdk
hacktoberfest recommendation-engine suggestion-engine tamber tamber-php
Last synced: 2 months ago
JSON representation
A PHP SDK for the Tamber API
- Host: GitHub
- URL: https://github.com/austinkregel/tamber-php-sdk
- Owner: austinkregel
- Created: 2017-03-21T04:21:02.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-08-12T19:20:33.000Z (almost 6 years ago)
- Last Synced: 2025-02-10T07:30:05.315Z (4 months ago)
- Topics: hacktoberfest, recommendation-engine, suggestion-engine, tamber, tamber-php
- Language: PHP
- Size: 10.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# The [Tamber](https://tamber.com) PHP SDK
This is an UNOFFICIAL SDK.
## Get your api Token by creating an account
The first thing to do is head to the [official Tamber website](https://tamber.com) to register
## Download the project
When this package is finally on packagist, you'll be able to install it using
```
composer require kregel/tamber
```
# Usage of this package
### Event
```php
track([
/**
* This will be created if it doesn't exist by default (via Tamber's code not this package)
*/
'user' => 'your user id using whatever format you want',
/**
* This can be anything from likes, dislikes, purchases, clicks, reads, ect.
* This will be created if it doesn't exist by default (via Tamber's code not this package)
*/
'behavior' => 'like',
/**
* If I were using Laravel I might do something like `App\User:1` or `App\Models\Transaction:810`. Something to signify the thing performing
* that's performing said beahvior and the identifier to track that thing's previous behaviors.
*/
'item' => 'spotify:track:1JIgaRnqtzS7DuGM3hVZU9',
/**
* The Tamber docs mention the context could be related to A/B testing for interface changes.
* but it could also be used to track the user's current url, previous things the user clicked on or other actions that the user preformed
* like whether or not they played the song or read the book.
*/
'context' => [
'home-page',
],
/**
* This is just to indicate whether or not this specific behavior was related to a recommened/suggested action.
* i.e. Did they play the song because it was in your recommended list?
*/
'hit' => false,
]);
print_r($response->getContents());
} catch (\Kregel\Tamber\Exceptions\TamberException $e) {
echo $e->getMessage() . "\n";
print_r($e->getContext());
}
```
### Behaviors
```php
create([
'name' => 'purchase',
'desirability' => 0.6
]);
} catch (\Kregel\Tamber\Exceptions\TamberException $e) {
echo $e->getMessage() . "\n";
print_r($e->getContext());
}
```
### Items
Creating
```php
create([
'id' => 'App\Song:1', // This just needs to be some kind of unique identifier.
'properties' => [
'artist' => 'Logic',
'title' => 'Under Pressure',
'length' => '9:20',
'explicit' => true
],
'tags' => [
'rap', 'hip-hop'
],
'created' => App\Song::find(1)->created_at // This is just to represent when the song was created in your system.
]);
} catch (\Kregel\Tamber\Exceptions\TamberException $e) {
echo $e->getMessage() . "\n";
print_r($e->getContext());
}
```
Getting an item
```php
retrieve([
'id' => 'spotify:track:5LME7YULt0enp6UAB8VoDn'
]);
```
### Side notes
It should be noted that each item in the Tamber API uses the `TransformRequest` trait. That means we hijack the
calls to the SDK and transform them into something a bit more usable.
Using the behavior creation example above. You can access any of the response data by simply trying to access it from the behavior variable.
```php
$behavior->result->name // purchase
$behavior->status // 200
$behavior->success // true
// ect...
```