All SDK methods called are guaranteed to : 1. We've made it even easier than that, by building in a queue to the SDK! The only thing that is required is that branch.init() is called prior to any other methods. Initializing the SDK is an asynchronous method with a callback, so it may seem as though you would need to place any method calls that will execute immediately inside the branch.init() callback. You will need to create a Branch Metrics app to obtain your Branch Key (you will have the option to toggle between live and test modes). Just require('branch') or define(, function(branch) ) to get started! Initialization In addition to working as a standalone library, the Branch SDK works great in CommonJS environments (browserify, webpack) as well as RequireJS environments (RequireJS/AMD).

You can also get the sdk via npm or bower (branch-sdk) Common.JS and RequireJS compatibility Browser Specific Support ChromeĪdd the following script within your tags:īe sure to replace BRANCH KEY with your actual Branch Key found in your account dashboard. No 3rd party libraries are needed to make use of the SDK as is it 100% native Javascript.

This SDK requires native browser Javascript and has been tested in all modern browsers with sessionStorage capability. Refrain from manually editting example.html. To modify this local web app, edit src/web/ first, and then run make, which will automatically update example.html. Alternatively, you can open example.html locally to for the same effect. We provide a sample web app which demonstrates what Branch Metrics Web SDK can do. It also offers event tracking, access to referrals, and management of credits. Once initialized, the Branch Web SDK allows you to create and share links with a banner, over SMS, or your own methods. You'll also need to register when your users login with setIdentity, and when they logout with logout. To use the Web SDK, you'll need to first initialize it with your Branch Key found in your Branch dashboard. It requires no frameworks, and is only ~13K gzipped. The Branch Web SDK provides an easy way to interact with the Branch API on your website or web app. This README outlines the functionality of the Branch Web SDK, and how to easily incorporate it into a web app. v2.25.0 patches a critical bug in anticipation of iOS 11. NOTE: For all users that are on a version earlier than v2.25.0 please update to the latest version.

For ios download Zero Install 2.25.2