Getting started with Seeka SDKs and APIs
These docs outline the usage of Seeka across various platforms.
If you require assistance, reach out to support@seeka.co.
Requirements
| Name | Required | Description |
|---|---|---|
| Organisation ID | For all APIs and SDKs | Uniquely identifies your Seeka organisation |
| Public key | When interacting with SDKs or the HTTP API | Allows write only access to API. Scoped to a single Converge instance and organisation brand |
| Package registry token | When installing NPM and NuGet packages | Grants access to pull packages from Seeka's private package registries |
| Package registry username | When installing NuGet packages | Grants access to pull packages from Seeka's private NuGet registry |
Installation methods
Seeka supports a number of installation methods. Your website, backend or frontend stack will determine which method is right for you.
Websites and modern web apps
- For Shopify and Wordpress websites - install the plugins available for these platforms.
- For modern web apps that are powered by module bundling (Webpack, Babel, Browserify, Rollup etc.) or that utilise single page frameworks such as React, Vue.js or Angular - use the modern web apps method.
- For all other websites and front ends - use the script tag method.
Backend
For server or backend environments, it is recommended to use one of the platform specific SDKs (.NET or JavaScript) which conform to semantic versioning principals.
A backend installation is only required if you wish to send events or enrich identity profiles without embedding Seeka on your front end website or mobile app.
If a SDK for your backend platform is not yet available then the HTTP API method is recommended.
Mobile apps
For mobile apps, it is recommended to use one of the platform specific SDKs (Xamarin or React Native) which conform to semantic versioning principals.
If a SDK for your mobile app platform is not yet available then the HTTP API method is recommended.
Software vendors
If you are a software vendor and wish to integrate Seeka into your product, please reach out to support@seeka.co.
When providing installation of Seeka to your customers, any one of the installation methods can be used.
To facilitate installation of Seeka, your application will need to provide a way for your customers to provide their Seeka Organisation ID and Public key which will allow you to initialise the Seeka SDKs and APIs for that customer.