# Kursaha SDK Integration Guide

The Kursaha SDK provides libraries and tools to integrate with your application. Here’s how you can use the SDK with different programming languages and APIs to connect seamlessly to your system.

💡 SDK

SDK stands for Software Development Kit, which provides a set of libraries and tools that you can integrate into your application.

# Prerequisites

To use the SDK, you need an API Key. If you don't have one, please refer to this page for instructions on generating your API Key.

# SDK Integration

Add the Kursaha SDK to your build.gradle file:

dependencies {
    ...
    implementation 'com.kursaha:java-sdk:0.0.16'
}

Initialize the client:

/**
 * Create a unique API key from <a href="https://kursaha.com/engage-data-drive/settings/api-key">API Key</a>.
 * Add that API key to your system environment.
 */
private final String apiKey = System.getenv("KURSAHA_KEY"); // Environment variable name
private final KursahaClient kursahaClient;

Add Kursaha SDK to your package.json file:

"dependencies": {
    ...
    "kursaha-sdk": "^1.0.8"
}

Install the Kursaha SDK:

go get github.com/kursaha/go-sdk

Initialize the client:

kursahaClient := kursaha.NewKursaha("<YOUR-API-KEY>")

To interact with the REST API, include the following headers in your requests:

Content-Type: application/json
Authorization: Bearer Your-Api-Key

# Methods

# Signal Start Event

// unique ID for a user, this ID should be constant across the workflow journey
String emitterId = String.valueOf(UUID.randomUUID());

// Eventflow identifier can be found @ https://kursaha.com/engage-data-drive/eventflow
UUID eventflowIdentifier = UUID.fromString("event-flow-identifier");

// Unique id of the step node
String stepNodeId = "start_event";
kursahaClient.edd.signal(eventflowIdentifier, stepNodeId, emitterId);

var Kursaha = require("kursaha-sdk"); // in Javascript file
// OR
import Kursaha from "kursaha-sdk"; // in Typescript file

// Initialize the SDK with your API key
var kursahaClient = new Kursaha("<YOUR-API-KEY>");

const signal = {
  customerId: "unique-customer-id",
  eventType: "event_type",
  data: {},
  eventflowIdentifier: "uuid",
};

kursahaClient.signal(signal);

signal := edd.Signal{
    EmitterID:           "unique-customer-id",
    StepNodeID:          "event_type",
    Data:                map[string]interface{}{},
    EventFlowIdentifier: "uuid",
}
err := client.Edd.SendSignal([]edd.Signal{})
if err != nil {
    print(err.Error())
} else {
    print("successfully sent signal!")
}

curl --location 'https://edd.kursaha.com/api/event-flows/signal' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API-KEY>' \
--data '{
    "requestIdentifier": "UUID",
    "signals": [
        {
            "customerId": "unique-customer-id",
            "eventType": "event_type",
            "data": {},
            "eventflowIdentifier": "event_flow_id"
        }
    ]
}'

Field Descriptions:

requestIdentifier: Unique UUID to track the request.
signals: List of signals to send in one API call.
emitterId/customerId: Unique ID for the emitter.
stepNodeId/eventType: Step node ID.
data: User data for the specific event.
eventflowIdentifier: Identifier for the event flow.

# Sending Customer Data

Send customer data using the following endpoint:

POST https://edd.kursaha.com/api/customers

// Unique Id of your Customer
String customerId = "<Unique-customer-id>";

// Details of your Customer
CustomerData customerData = new CustomerData();
customerData.setEmail("john.deo@sqs.com");
// ... Please provide all the details of that customer

kursahaClient.edd.sendCustomerData(customerId, customerData);

const customerData = {
  customerId: "<Unique-customer-id>",
  customerData: {
    email: "j.doe@swq.com",
    phoneNumber: "+911002220000",
    firstName: "John",
    lastName: "Doe",
    gender: "",
    dob: "",
    city: "",
    state: "",
    country: "",
    zip: "",
  },
};

kursahaClient.sendCustomerData(customerData);

Coming soon.

curl --location 'https://edd.kursaha.com/api/customers' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API-KEY>' \
--data-raw '{
    "customerId": "<Unique-customer-id>",
    "customerData": {
        "email": "j.doe@swq.com",
        "phoneNumber": "+911002220000",
        "firstName": "John",
        "lastName": "Doe",
        "gender": "",
        "dob": "",
        "city": "",
        "state": "",
        "country": "",
        "zip": ""
    }
}'

# Sending Events

Send events to Kursaha using the following endpoint:

POST https://edd.kursaha.com/api/event-flows/signal

    ...
    String uniqueCustomerId = "<unique-customer-id>";
    String eventType = "signup";
    kursaha.edd.signal(eventType, uniqueCustomerId, data);
    ...

const event = {
  customerId: "<unique-customer-id>",
  eventType: "<event-type>",
  data: {
    price: 200,
    brand: "something",
    productId: "",
    category: "",
    subCategory1: "",
    subCategory2: "",
    subCategory3: "",
  },
};

kursahaClient
  .sendEvent(event)
  .then((response) => {
    console.log("Event sent successfully:", response);
  })
  .catch((error) => {
    console.error("Error sending event:", error);
  });

Coming soon.

curl --location 'https://edd.kursaha.com/api/event-flows/signal' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API-KEY>' \
--data-raw '{
    "signals": [
        {
            "customerId": "<Unique-customer-id>",
            "eventType": "<event-type>",
            "data": {
                "price": 200,
                "brand": "something",
                "productId": "",
                "category": "",
                "subCategory1": "",
                "subCategory2": "",
                "subCategory3": ""
            }
        }
    ]
}'

Field Descriptions:

customerId: Unique identifier for the customer.
signals: List of events to send in one API call.
eventType: Type of the event.
data: Data associated with the event, including attributes like price, brand, product ID, category, etc.

Leverage this seamless integration to transmit crucial user behavior data to Kursaha, enhancing your customer engagement and acquisition strategies. Connect with your audience like never before!