Download the PHP package visitor-analytics/3as-sdk without Composer
On this page you can find all versions of the php package visitor-analytics/3as-sdk. 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 3as-sdk
TWIPLA PHP SDK
A simple API wrapper for integrating the Analysis as a Service (3AS) APIs provided by TWIPLA
Getting started
- Create an RSA Key Pair (PEM format)
- Send the resulting public key (
jwtRS256.key.pub) to the TWIPLA Dev Team - Install the library
- Use the SDK instance to interract with the API
Creating an RSA Key pair
- Create the keypair:
ssh-keygen -t rsa -b 2048 -m PEM -f jwtRS256.key - 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
- Customer (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 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.
Example implementation flow
- Create a new customer with a website
- Inject the resulting tracking code in the website's HTML
- Use the SDK's generate iframe url method to create an url
- Show an iframe to the user with the url created previously
- Show a modal to the user to upgrade his subscription
- Display all the available packages using the SDK
- After the payment is complete, use the SDK to upgrade the subscription of the website
Available APIs
- Customers
- Customer
- Package
- Packages
- Website
- Websites
- Utils
Customers API
Integration partners (INTP) are able to get data about their customers (INTPc).
Register a new customer
List all available customers
Get a single customer by its INTP given id
Customer 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
Website API
Delete a website by its INTP given id
API for managing subscription state
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, reversible by an upgrade
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:
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.
All versions of 3as-sdk with dependencies
lcobucci/jwt Version ^5.0.0
guzzlehttp/guzzle Version ^7.0.0
ext-json Version *
ext-openssl Version *
laminas/laminas-hydrator Version ^4.0.0
respect/validation Version ^2.0.0