This Quick Start Guide will help you get up and running with the IndyKite platform. In just a few steps, you'll learn how to connect your data, create contextually relevant queries and apply authorization policies.

What we do: IndyKite is a real-time data retrieval and enforcement layer that is purpose built to bring deep context, granular control and usability to your enterprise data.

With IndyKite you can build more contextually relevant apps and AI faster and safer. This means better experiences for your users - internal or external, human or nonhuman.

Think of IndyKite as the trust and intelligence layer between your data and the systems that use it. Now it's time to get to building!

How do I access the platform?

Before you can access the IndyKite platform, you need to register into our Sandbox.

IndyKite Sandbox - Create an account - https://sandbox.indykite.com/login/Peuc130xTGYVIZfUwSdXQsFBsgjoDMp2?bg=%231a1a1a&flow=sign-up&width=480px

When you are registered, you will be redirected to the IndyKite Hub: https://eu.hub.indykite.com

Create an environment

Once you have an account, you will need to create a work environment:

Service account credentials: https://eu.hub.indykite.com/service-accounts (or https://us.hub.indykite.com/service-accounts)

A Service Account, with its Credential, is an entity created under an Organization which manages all configurations in the Config API.

Download the generated credentials:

Project, Application, Application Agent, Application Agent Credentials can be created either in the Hub, Terraform or REST APIs.

A Project is an isolated working environment inside your organization. It is created with an IndyKite Knowledge Graph (IKG), which is a Neo4j instance, and hosts Applications created under it.

If you don't have an instance yet, you can get free instances here:

https://console.neo4j.io

https://neo4j.com/product/auradb/

https://neo4j.com/download/

Quick get started app: with your organization ID and your service account credentials, you can easily create a project and an application, get application credentials, ingest data, create KBAC and ContX IQ policies and test them by following the instructions here: https://github.com/indykite/developer-hub/tree/master/get-started

Most steps are pre-filled with default values that can be left unchanged.

You can also create your environment in the Hub: eu.hub.indykite.com (or us.hub.indykite.com)

Add your neo4j / Aura information:

You can also use REST endpoints or Terraform.

Before using the REST endpoints or Terraform, you will need to have your Organization (or Customer) and a Service Account created in the HUB eu.hub.indykite.com (or us.hub.indykite.com

To create a Project (ApplicationSpace) with Terraform: https://developer.indykite.com/terraform/terraform-2

An Application, created under a Project with its Agent and Credential, is an entity users will interact with.

To create an Application: https://developer.indykite.com/terraform/terraform-2

To create an Application Agent: https://developer.indykite.com/terraform/terraform-2

To create an Application Agent credential: https://developer.indykite.com/terraform/terraform-2

To integrate with your own external Identity Provider, you must create a Token Introspection configuration, as follows: https://developer.indykite.com/terraform/terraform-1 or https://developer.indykite.com/resources/cred-1.

Products

Get's started with Capture

The Indykite platform needs data to operate. Data must therefore first be ingested, or captured into the empty graph of any new project.
To capture data into your IKG, you must transform it into the schema that the capture endpoints accept. https://openapi.indykite.com/api-documentation#tag/capture

You can find examples in https://developer.indykite.com/resources and https://github.com/indykite/developer-hub

Once the data is captured, it can be visualized in the HUB GUI here: https://eu.hub.indykite.com/explore/data-explorer

Get's started with CIQ

ContextIQ, or CIQ is the main means of interacting with the data captured in the platform. CIQ serves as an authorized Read/Update/Delete API. Client applications can use CIQ to query graph data or make real-time updates to it.

CIQ protects data through access policies defined in the platform's Knowledge-Based Access Control (KBAC) engine.

The following guide : https://developer.indykite.com/guides/guide-contx-iq explains how you can create ContX IQ policies and queries.

You will find full examples to be tested in https://developer.indykite.com/resources.

Get's started with Outbound Events / Signal

The IndyKite platform can publish outbound message events based on data changes or events that occur. These allow external systems to react to these events.

The outbound events guide is located here: https://developer.indykite.com/guides/guide-outbound-events which explains how to create an events configuration and how to send messages to your providers.

You will find full examples to be tested in https://developer.indykite.com/resources and https://developer.indykite.com/terraform.

Get's started with KBAC / AuthZEN

The Knowledge-Based Access Control (KBAC) authorization engine is an OpenID AuthZEN (link: https://openid.net/wg/authzen/) compliant authorization engine and Policy Decision point, that authorizes automatically the access to all the data stored in the IKG. It powers CIQ, but can also be invoke directly through the AuthZEN compliant API.

There are guides here: https://developer.indykite.com/guides/guide-dynamic-authz and https://developer.indykite.com/guides/guide-authzen which explain what is KBAC and what is AuthZEN and how to use them.

You will find full examples to be tested in https://developer.indykite.com/resources.