> ## Documentation Index
> Fetch the complete documentation index at: https://ekacare-quickstart-cleanup.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Golang

A Go SDK for integrating with Eka Care’s healthcare APIs, including ABDM (Ayushman Bharat Digital Mission) services.

## Overview

Use this SDK to authenticate with Eka Care, call ABDM services, and build backend integrations in Go with minimal boilerplate.

## Prerequisites

* Go 1.24+ (matches the SDK’s go.mod)
* Eka Care developer account and credentials (client\_id and client\_secret)

## Installation

```bash theme={null}
go get github.com/eka-care/eka-sdk-go
```

Install a specific version (recommended for reproducible builds):

```bash theme={null}
go get github.com/eka-care/eka-sdk-go@latest
# or pin to a specific release
go get github.com/eka-care/eka-sdk-go@vX.Y.Z
```

## Authentication and Setup

The SDK supports configuration via environment variables (recommended) or explicit options in code.

### Recommended: Environment variables

Set the following variables in your environment or a .env file:

```bash theme={null}
# Required
export EKA_ENVIRONMENT=production   # or development
export EKA_CLIENT_ID=your-client-id
export EKA_CLIENT_SECRET=your-client-secret
```

Then initialize the client from environment variables:

```go theme={null}
client := ekasdk.NewFromEnv()
```

### Alternative: Explicit configuration (not recommended for production)

```go theme={null}
client := ekasdk.New(
	ekasdk.WithEnvironment(ekasdk.EnvironmentProduction),
	ekasdk.WithClientID("your-client-id"),
	ekasdk.WithClientSecret("your-client-secret"),
)
```

## Quickstart

Authenticate and call an ABDM API (login init via PHR address):

```go theme={null}
package main

import (
	"context"
	"log"

	ekasdk "github.com/eka-care/eka-sdk-go"
	"github.com/eka-care/eka-sdk-go/internal/interfaces"
	"github.com/eka-care/eka-sdk-go/services/abdm/abha/login"
)

func main() {
	ctx := context.Background()

	// Create SDK client from environment variables
	client := ekasdk.NewFromEnv()

	// Authenticate with Eka platform
	if err := client.Login(ctx); err != nil {
		log.Fatalf("Authentication failed: %v", err)
	}

	// Common headers used by ABDM services
	headers := interfaces.Headers{
		PatientID:     "eka-user-oid",
		PartnerUserID: "your-user-id",
		HipID:         "your-hip-id",
	}

	// Example: ABDM login (init via PHR address)
	otpReq := &login.InitLoginRequest{
		Identifier: "demo@abdm",
		Method:     login.LoginMethodPhrAddress,
	}

	otpResp, err := client.ABDM.Login().LoginInit(ctx, headers, otpReq)
	if err != nil {
		log.Printf("ABDM login failed: %v", err)
		return
	}

	log.Printf("Success! Transaction ID: %s", otpResp.TxnID)
}
```

## Configuration reference

* EKA\_CLIENT\_ID: Client ID from the developer portal (required)
* EKA\_CLIENT\_SECRET: Client secret from the developer portal (required)
* EKA\_ENVIRONMENT: production or development (required)

Configuration priority (highest to lowest):

* Environment variables
* Explicit options via WithXxx() functions
* Built-in defaults

## Available services

Once authenticated, you can access:

* ABDM services: `client.ABDM.Login()`, `client.ABDM.Registration()`, `client.ABDM.Profile()`
* More services will be added as they become available

## Troubleshooting

Typical auth/config errors when calling `client.Login(ctx)`:

```text theme={null}
"client ID is required for authentication. Set EKA_CLIENT_ID environment variable or use WithClientID() option"
"client secret is required for authentication. Set EKA_CLIENT_SECRET environment variable or use WithClientSecret() option"
"failed to authenticate with provided credentials: invalid client credentials"
```

## Examples and resources

* GitHub repository: [https://github.com/eka-care/eka-sdk-go](https://github.com/eka-care/eka-sdk-go)
* Examples: [https://github.com/eka-care/eka-sdk-go/tree/main/examples/quickstart](https://github.com/eka-care/eka-sdk-go/tree/main/examples/quickstart)
* Issues & support: [https://github.com/eka-care/eka-sdk-go/issues](https://github.com/eka-care/eka-sdk-go/issues)