https://github.com/sirodiaz/php-klaviyo-api
Low level but elegant Klaviyo full API wrapper for PHP with asynchronous track event support
https://github.com/sirodiaz/php-klaviyo-api
analytics api api-client api-wrapper behavior ecommerce klaviyo php php7
Last synced: 11 months ago
JSON representation
Low level but elegant Klaviyo full API wrapper for PHP with asynchronous track event support
- Host: GitHub
- URL: https://github.com/sirodiaz/php-klaviyo-api
- Owner: SiroDiaz
- License: mit
- Created: 2018-04-16T15:24:50.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-05-28T13:29:02.000Z (almost 4 years ago)
- Last Synced: 2025-03-19T03:11:12.685Z (12 months ago)
- Topics: analytics, api, api-client, api-wrapper, behavior, ecommerce, klaviyo, php, php7
- Language: PHP
- Homepage: https://packagist.org/packages/siro/php-klaviyo-api
- Size: 78.1 KB
- Stars: 14
- Watchers: 1
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# php-klaviyo-api
[](https://travis-ci.org/SiroDiaz/php-klaviyo-api)
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3XKLA6VTYVSKW&source=url)
Klaviyo API wrapper for PHP. It allows to consume the Klaviyo v1 API using a clear and simple
PHP class format for make the usage user-friendly. Stuff like delete a list is as logic as doing:
`$klaviyo->list->delete('asdD2e2')`. Easy, isn't it?
## Installation
Installing php-klaviyo-api is simple. You just need Composer installed and added to the path. For install the
current last version run:
`composer require siro/php-klaviyo-api:"^1.6.0"`
## Usage
### API organization and usage
The php-klaviyo-api is organized as the official Klaviyo API, really.
If you want to access to event API you must do as follow:
```php
// klaviyo Event API
$klaviyo->event->track($event, $customerProperties, $properties);
$klaviyo->event->trackAsync($event, $customerProperties, $properties);
// email template API
$klaviyo->template->getAll();
$klaviyo->template->create('newuser', $htmlString);
// lists API
$klaviyo->list->getLists();
$klaviyo->list->create('premium');
```
A real example would be as i show here:
```php
event->trackAsync(
'register',
['email' => 'federico@gmail.com'],
[]
);
```
As you can see it is really easy. The code is good organized, with the same
documentation that the official one. You just need to read a bit and you will see that it is simple and intuitive.
### Klaviyo Event API
This API is used to track events to Klaviyo. This is the main feature
and you maybe would use it. By that reason i implemented this API wrapper
in this way.
For load it
## Contributing
This project uses **PSR-4** coding standard. If you want to make a contribution it must be important run `make sniff` for checking
your code before commit the changes.
At this moment it is prioritary making tests for the API so Pull requests for tests and fixes are welcome.
## Credits
All credits, at this moment, are for Siro Díaz Palazón .
## Contributors
At this moment main contributors are:
- Siro Díaz Palazón [SiroDiaz](https://github.com/SiroDiaz)
- Lukasz [Blysq](https://github.com/Blysq)
## License
This project is licensed under MIT.