Installation & Configuration

Installation

Node.js

npm install @tingee/sdk-node
# or
yarn add @tingee/sdk-node
# or
pnpm add @tingee/sdk-node

Requirements: Node.js ≥ 18

Java

Maven

<dependency>
  <groupId>vn.tingee</groupId>
  <artifactId>sdk-java</artifactId>
  <version>[0.2.4,)</version>
</dependency>

Gradle

implementation 'vn.tingee:sdk-java:[0.2.4,)'

Requirements: Java ≥ 17

C#

dotnet add package Tingee.Sdk

or via the NuGet Package Manager:

Install-Package Tingee.Sdk

Requirements: .NET 8+

PHP

composer require tingee/sdk-php

Requirements: PHP ≥ 8.0

---

Client configuration

Node.js

import { TingeeClient } from '@tingee/sdk-node';

const client = new TingeeClient({
  secretKey:   process.env.TINGEE_SECRET_KEY!,
  clientId:    process.env.TINGEE_CLIENT_ID!,
  environment: 'production', // 'uat' | 'production'
  timeout:     90000,        // ms, default 90000
  // baseUrl: 'https://custom-url.example.com', // overrides environment
});

Option	Type	Default	Description
secretKey	string	—	Required. Secret key from the Tingee Dashboard
clientId	string	—	Required. Client ID from the Tingee Dashboard
environment	'uat' | 'production'	'production'	API environment
baseUrl	string	—	Overrides the URL (ignores environment)
timeout	number	90000	Timeout (ms)

Java

import vn.tingee.sdk.TingeeClient;
import vn.tingee.sdk.client.TingeeEnvironment;

TingeeClient client = TingeeClient.builder(
        System.getenv("TINGEE_SECRET_KEY"),
        System.getenv("TINGEE_CLIENT_ID"))
    .environment(TingeeEnvironment.PRODUCTION) // UAT | PRODUCTION
    .timeout(90000)                            // ms, default 90000
    // .baseUrl("https://custom-url.example.com") // overrides environment
    .build();

Parameter	Type	Default	Description
secretKey	String	—	Required. Secret key from the Tingee Dashboard
clientId	String	—	Required. Client ID from the Tingee Dashboard
environment	TingeeEnvironment	PRODUCTION	UAT | PRODUCTION
baseUrl	String	—	Overrides the URL (ignores environment)
timeout	int	90000	Timeout (ms)

C#

using Tingee.Sdk.Client;

var client = new TingeeClient(new TingeeClientOptions
{
    SecretKey   = Environment.GetEnvironmentVariable("TINGEE_SECRET_KEY")!,
    ClientId    = Environment.GetEnvironmentVariable("TINGEE_CLIENT_ID")!,
    Environment = TingeeEnvironment.Production, // Uat | Production
    // BaseUrl  = "https://custom-url.example.com", // overrides Environment
});

Property	Type	Default	Description
SecretKey	string	—	Required. Secret key from the Tingee Dashboard
ClientId	string	—	Required. Client ID from the Tingee Dashboard
Environment	TingeeEnvironment	Production	Uat | Production
BaseUrl	string?	—	Overrides the URL (ignores Environment)
TimeoutMilliseconds	int	90000	Timeout (ms)

PHP

<?php
require_once 'vendor/autoload.php';

use Tingee\Sdk\TingeeClient;

$client = new TingeeClient(
    secretKey:   $_ENV['TINGEE_SECRET_KEY'],
    clientId:    $_ENV['TINGEE_CLIENT_ID'],
    environment: 'prod',  // 'prod' | 'uat'
    timeout:     90,      // seconds, default 90
    // baseUrl: 'https://custom-url.example.com', // overrides environment
);

Parameter	Type	Default	Description
secretKey	string	—	Required. Secret key from the Tingee Dashboard
clientId	string	—	Required. Client ID from the Tingee Dashboard
environment	string	'prod'	'prod' | 'uat'
timeout	int	90	Timeout (seconds)
baseUrl	string|null	—	Overrides the URL (ignores environment)

Important security note

Use secretKey on the server side only. Never embed it in a frontend, mobile app or any other client-side environment.

---

Framework integration

Node.js (NestJS)

// tingee.module.ts
import { Module, Global } from '@nestjs/common';
import { TingeeClient } from '@tingee/sdk-node';

@Global()
@Module({
  providers: [
    {
      provide: TingeeClient,
      useFactory: () => new TingeeClient({
        secretKey: process.env.TINGEE_SECRET_KEY!,
        clientId:  process.env.TINGEE_CLIENT_ID!,
      }),
    },
  ],
  exports: [TingeeClient],
})
export class TingeeModule {}

Java (Spring Boot)

@Configuration
public class TingeeConfig {

    @Bean
    public TingeeClient tingeeClient(
            @Value("${tingee.secret-key}") String secretKey,
            @Value("${tingee.client-id}")  String clientId) {
        return TingeeClient.builder(secretKey, clientId)
            .environment(TingeeEnvironment.PRODUCTION)
            .build();
    }
}

# application.yml
tingee:
  secret-key: ${TINGEE_SECRET_KEY}
  client-id: ${TINGEE_CLIENT_ID}

C# (ASP.NET Core)

// Program.cs
builder.Services.AddSingleton(new TingeeClientOptions
{
    SecretKey   = builder.Configuration["Tingee:SecretKey"]!,
    ClientId    = builder.Configuration["Tingee:ClientId"]!,
    Environment = TingeeEnvironment.Production,
});
builder.Services.AddSingleton<TingeeClient>();

// appsettings.json
{
  "Tingee": {
    "SecretKey": "your-secret-key",
    "ClientId":  "your-client-id"
  }
}

PHP (Laravel)

// AppServiceProvider.php
use Tingee\Sdk\TingeeClient;

public function register(): void
{
    $this->app->singleton(TingeeClient::class, fn () => new TingeeClient(
        secretKey:   config('services.tingee.secret_key'),
        clientId:    config('services.tingee.client_id'),
        environment: config('services.tingee.environment', 'prod'),
    ));
}

// config/services.php
'tingee' => [
    'secret_key'  => env('TINGEE_SECRET_KEY'),
    'client_id'   => env('TINGEE_CLIENT_ID'),
    'environment' => env('TINGEE_ENV', 'prod'),
],