Download the PHP package iivannov/branchio without Composer
On this page you can find all versions of the php package iivannov/branchio. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 branchio
Branch Metrics (Branch.io) HTTP API Client
This is just a simple HTTP client for the Branch Metrics API (Branch.io). At the moment it supports creating, updating and configuring Branch links. A future version will include retrieving data from existing links.
Table of Contents
- Important Notice
- Installation
- Basic usage
- Get link data
- Create new link
- Advanced Usage
- Configure link instance
- Analytical Data
- Configure Link type
- Configure custom data
- Create link
- Update link
- Usage with Laravel
- License
Important Notice
The latest versions after 1.1.x are not backwards compatible with the old versions 1.0.x.
Be careful when updating! If you want to upgrade to versions 1.1.x, please first follow the documentation to make the needed changes in your code
Installation
The package can be installed with Composer. Just run this command:
Basic usage
Get link data
Create new link
Advanced Usage
Configure link instance
Link instance contains all the configurable options for a Branch Metrics link and provides method to set them.
Analytical Data
For full reference about the analytical options available please see: https://docs.branch.io/pages/links/integrate/#analytical-labels
| Key | Usage |
|---|---|
| channel | Use channel to tag the route that your link reaches users. For example, tag links with 'Facebook' or 'LinkedIn' to help track clicks and installs through those paths separately |
| feature | This is the feature of your app that the link might be associated with. For example, if you had built a referral program, you would label links with the feature 'referral' |
| campaign | Use this field to organize the links by actual campaign. For example, if you launched a new feature or product and want to run a campaign around that |
| stage | Use this to categorize the progress or category of a user when the link was generated. For example, if you had an invite system accessible on level 1, level 3 and 5, you could differentiate links generated at each level with this parameter |
| tags | This is a free form entry with unlimited values ['string']. Use it to organize your link data with labels that don't fit within the bounds of the above |
| alias | Specify a link alias to replace of the standard encoded short URL. Link aliases must be unique (a 409 error will occur if you create an alias already taken). Appending a / will break the alias. bnc.lt link domain alias links are incompatible with Universal Links and Spotlight. |
| type | Must be an int. Set to 1 to limit deep link to a single use. Set to 2 to make the link show up under Quick Links while adding $marketing_title to data. Does not work with the Native SDKs |
Configure Link type
You can easily set the deep linking behaviour by passing the type parameter. You have the following options:
UrlType::DEFAULT_TYPE - default value,
UrlType::ONCE - to limit deep linking behavior of the generated link to a single use,
UrlType::MARKETING_TYPE - to make the link show up under Marketing page in the dashboard
Configure custom data
For full description of possible $data options, please see:
https://docs.branch.io/pages/links/integrate/#redirections
Create link
To create the configured link, just call the createLink method and pass the Link' instance
Update link
To update an already existing link you need to pass the url of the link and the updated Link instance to the updateLink method
Usage with Laravel
If you are using Laravel, the package contains a Service Provider and a Facade for you.
-
First you need to add the ServiceProvider and Facade classes in your
config\app.php -
Then you need to add your username and password in
config\services.php - You are ready to go, just use the facade:
License
The MIT License (MIT). Please see License File for more information.
