Download the PHP package visitor-analytics/3as-sdk without Composer

TWIPLA PHP SDK

A simple API wrapper for integrating the Analysis as a Service (3AS) APIs provided by TWIPLA

Getting started

1. Create an RSA Key Pair (PEM format)
2. Send the resulting public key (jwtRS256.key.pub) to the TWIPLA Dev Team
3. Install the library
4. Use the SDK instance to interract with the API

Creating an RSA Key pair

1. Create the keypair: ssh-keygen -t rsa -b 2048 -m PEM -f jwtRS256.key
2. Convert the public key to PEM: openssl rsa -in jwtRS256.key -pubout -outform PEM -out jwtRS256.key.pub

Installation

Composer

Install via Composer

How to use the library

Concepts

Terms

• INTP (Integration Partner)\ The company that is integrating the analytics as a service solution (3AS)
• STPs (Server Touchpoints)\ Credits used to measure data usage for a given website
• Intpc (INTPC integration partner customer)\ One user of the INTP, can have many websites
• Website\ The website where data will be tracked. It has a subscription with a package with a certain limit of STPs. This subscription can be upgraded or downgraded. When the website is created a tracking code snippet is returned that must be embedded within the websites HTML.
• Package\ A package has a price and contains a certain number of STPs. They are used when upgrading/downgrading the subscription of a website.

General

Most endpoints that deal with customers or websites support some form of an ID which can be provided and then used for all following requests.

For example creating a new customer with a website requires an intpCustomerId|intpcId and an intpWebsiteId. These must be provided by the INTP and are intended to make integrations easier because there is no need to save any external IDs. Then when getting data about a customer the request is done using the same intpCustomerId provided on creation.

Subscription Types

There are currently two types of subscription available:

1. Website Subscription

• Applies to a single website.
• Created using an intp package, which defines the subscription plan.
• Can be billed monthly or yearly.
• Each website subscription is tied to an intpc, which is the entity responsible for creating the website.

2. Intpc Subscription

• Covers one or more websites under a single subscription.
• Created using an intp package, which defines the subscription plan.
• Can be billed monthly or yearly.
• The touchpoint limit defined by the package is shared across all associated websites.
• The intpc can monitor individual usage per website, providing detailed insights into how each site consumes touchpoints.
• Ideal for managing multiple websites with a centralized billing.

Example implementation flow

1. Create a new intpc with a website
2. Inject the resulting tracking code in the website's HTML
3. Use the SDK's generate iframe url method to create an url
4. Show an iframe to the user with the url created previously
5. Show a modal to the user to upgrade his subscription
6. Display all the available packages using the SDK
7. After the payment is complete, use the SDK to upgrade the subscription of the website

Available APIs

• INTPCs
• INTPC
• Package
• Packages
• Website
• Websites
• Utils

INTPCs API

Integration partners (INTP) are able to get data about their customers (INTPc).

Register and start an INTPc level subscription. This will allow subsequently added websites to consume from the same touchpoint pool provided by the package used during setup.

Register an INTPc and start a website level subscription. Each added website will have its own subscription.

List all available customers

Get a single intpc by its INTP given id

INTPC API

List all websites belonging to an INTP Customer

Delete a Customer belonging to an INTP

Generate the VisitorAnalytics Dashboard IFrame Url

This is one of the essential methods to use when using the iframe appoach 3AS. It creates an URL for a given customer and website combination that shows the TWIPLA dashboard in the theme configured by the INTP.

Packages API

An Integration Partner (INTP) is able to get data about their packages

List all available packages

Get a single package by ID

Create a package

Package API

An INTP can update its packages

Websites API

List all websites

Get a single website by its INTP given id

Create a website with its own subscription and attach it to an existing INTPc

Create a website and attach it to an existing INTPc subscription. This website, alongside other pre-existing website will consume touchpoints from the same pool.

Create a website with its own 30 day, unlimited free trial subscription and attach it to an INTPc. After the 30 day free trial ends, the subscription will be downgraded to the free package.

Website API

Delete a website by its INTP given id

Add a whitelisted domain

Delete a whitelisted domain

List all whitelisted domains

API for managing a subscription of type website

Upgrade - immediately applies a higher stp count package to the subscription

Downgrade - auto-renew the subscription at the end of the current billing interval to a new lower stp count package

Cancel - disable the subscription auto-renewal at the end of the current billing interval

Resume - re-enable the subscription auto-renewal at the end of the current billing interval

Deactivate - immediately disables the subscription

API for managing a subscription of type intpc

Upgrade - immediately applies a higher stp count package to the subscription

Downgrade - auto-renew the subscription at the end of the current billing interval to a new lower stp count package

Cancel - disable the subscription auto-renewal at the end of the current billing interval

Resume - re-enable the subscription auto-renewal at the end of the current billing interval

Deactivate - immediately disables the subscription

Utils API

Generate a valid access token for the current INTP configuration.

Generate a valid access token for the current INTPc configuration.

Dashboard IFrame

The IFrame is one of the main ways a user can interract with the data gathered for his website. The URL of the IFrame is generated using the SDK

The resulting URL can be further enhanced with query parameters:

1. allowUpgrade=true - Show upgrade CTAs

Upgrade buttons will be added to the Dashboard for all features that require a certain minimum package. Once the upgrade button is clicked, the iframe posts a message to the parent frame, containing the following payload:

Pagination

list methods support pagination options as follows:

If no pagination options are provided, the pageSize defaults to 10 items.

The page count starts from 0.