Download the PHP package dhrechanyi/activecampaign-api-v3-wrapper without Composer
On this page you can find all versions of the php package dhrechanyi/activecampaign-api-v3-wrapper. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dhrechanyi/activecampaign-api-v3-wrapper
More information about dhrechanyi/activecampaign-api-v3-wrapper
Files in dhrechanyi/activecampaign-api-v3-wrapper
Package activecampaign-api-v3-wrapper
Short Description Wrapper for ActiveCampaing API v3, which allows to work with their services, using PHP
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package activecampaign-api-v3-wrapper
ActiveCampaign API v3 Wrapper
Wrapper for ActiveCampaign API v3.\ Allows to make calls in ActiveCampaign services and work with data, using PHP. Simple and easy to use. \ Services available so far:
- Lists
- Contacts
- Tags
Official API documentation
https://developers.activecampaign.com/v3/reference
Installation
ActiveCampaign API v3 Wrapper is available on Packagist. Just add this line to your composer.json file in require section
or open terminal window and run
Usage
Wrapper allows you to chain methods and use singe instance to apply all needed filters and queries.
Setup
Get service models
To get access to activecampaign api endpoints, you need to create service model first. Here is how you can do it:
Basic example
To retrieve all lists, call for the ->all() method. This method should be always at the very end of your chain sequence:
Note that by default, activecampaign api returns 20 items. To change that, you need to use pagination() method
Pagination
https://developers.activecampaign.com/v3/reference#pagination \ Pagination allows you to get needed amount of items and make offsets.
Sorting
https://developers.activecampaign.com/v3/reference#section-ordering \
You can sort results in needed order. Use ->orderby() method and pass as argument an array, where key is the name of field and value is order (asc or desc).
Filtering
https://developers.activecampaign.com/v3/reference#section-filtering \
You can filter results by multiple parameters. Use ->filter() method and pass an array as argument, where key is parameter name and value is parameter value.
URL Queries
Additionaly, you can add any parameter to url that will be send to activecampaign endpoint. Use ->query() method and pass as argument an array with parameters key and value
Get item by ID
To access any item by it's ID, use ->get($id) method.
Advanced examples
Available methods
Lists
https://developers.activecampaign.com/v3/reference#lists
| Method | Description |
|---|---|
| get($list_id) | Get list by ID |
| all() | Get all lists |
| create($params) | Create list https://developers.activecampaign.com/reference#create-new-list |
| createGroup($params) | Create list group permission https://developers.activecampaign.com/reference#create-a-list-group-permission |
| delete($list_id) | Delete list by ID |
NOTE: When creating a new list, it is important to then associate that list to a group permission
Contacts
https://developers.activecampaign.com/v3/reference#contact
| Method | Description |
|---|---|
| get($contact_id) | Get contact by ID |
| getByList($list_id) | Get contacts by list ID |
| getByTag($tag_id) | Get contacts by tag ID |
| getByEmail($email) | Get contact by email |
| all() | Get all contact |
| create($params) | Create contact https://developers.activecampaign.com/reference#create-contact |
| createOrUpdate($params) | Create contact or update if it's already exists (sunc by email) https://developers.activecampaign.com/reference#create-contact-sync |
| update($contact_id, $params) | Update contact https://developers.activecampaign.com/reference#update-a-contact |
| delete($contact_id) | Delete contact by ID |
| getCustomFieldValue($custom_field_id) | Get custom field value |
| allCustomFieldValues() | Get all custom fields values |
| createCustomFieldValue($params) | Create custom field value https://developers.activecampaign.com/reference#retrieve-fields |
| addTag($params) | Add tag to contact https://developers.activecampaign.com/reference#create-contact-tag |
| deleteTag($contact_tag_id) | Delete tag from contact |
| getTags($contact_id) | Get all contact's tags |
| getLists($contact_id) | Get all contact's lists |
| updateListStatus($params) | Update list status on contact https://developers.activecampaign.com/reference#update-list-status-for-contact |
| getContactFieldValues($contact_id) | Get contact field values |
| updateCustomFieldValue($custom_field_id, $params) | Update contact custom field value |
Tags
https://developers.activecampaign.com/reference#tags
| Method | Description |
|---|---|
| get($tag_id) | Get tag by ID |
| all() | Get all tags |
| create($params) | Create tag https://developers.activecampaign.com/reference#create-a-new-tag |
| update($tag_id, $params) | Update tag https://developers.activecampaign.com/reference#update-a-tag |
| delete($tag_id) | Delete tag by ID |
