Panduan SDK

SDK Orbit Global Informasi menyediakan integrasi modular untuk OCR KTP, face liveness, face match, dan NIK validation. Setiap layanan dapat diaktifkan sesuai paket dan kebutuhan integrasi.

REST API tersedia untuk integrasi server-to-server. Untuk pengalaman kamera seperti video liveness, gunakan SDK agar proses capture, pengiriman frame, dan status session berada dalam alur yang terkelola.

Mulai dengan SDK

Import class Ogi, lalu buat satu instance SDK dengan Publishable Key dari dashboard.

const ogi = new Ogi({ publishableKey: 'pk_test_...' });

Gunakan instance ogi untuk membuat session dan menjalankan service verifikasi.

Kebutuhan	Method	Catatan
Membuat sesi client	`createSession()`	Menghasilkan `client_token` berumur pendek.
OCR KTP	`extractKtp()`	Mengunggah foto KTP dan mengembalikan `document_result`.
Face liveness selfie	`checkFaceLiveness()`	Untuk selfie statis dari file atau capture kamera.
Video liveness kamera	`runVideoLiveness()` / `submitVideoLiveness()`	Web SDK bisa capture kamera langsung; React/RN bisa kirim frame dari UI kamera app.
Face match	`matchFace()` / `matchFaces()`	Mencocokkan foto identitas dengan selfie.
NIK validation	`validateNik()`	Dipanggil dari backend dengan Secret Key.
Menutup sesi	`complete()` / `completeSession()`	Mengembalikan status akhir sesi.

Pilihan Flow

Flow	Cocok untuk	Service yang dipanggil
`ocr_only`	Ekstraksi data KTP.	`createSession()`, `extractKtp()`, opsional `complete()`
`liveness_only`	Pemeriksaan keaslian wajah pengguna.	`createSession()`, `checkFaceLiveness()` atau `runVideoLiveness()`, opsional `complete()`
`face_match`	Pencocokan foto identitas dengan selfie.	`createSession()`, `matchFace(idImage, selfieImage)`, opsional `complete()`
`identity_verification`	Kombinasi OCR, liveness, dan face match.	Jalankan service sesuai konfigurasi produk.
`nik_validation`	Validasi data NIK terhadap sumber resmi.	`validateNik()` dari backend dengan Secret Key.

Pola Kunci

Browser dan mobile menggunakan Publishable Key untuk membuat SDK session.
Backend menggunakan Secret Key untuk NIK validation dan REST API server-to-server.
Secret Key tidak boleh disimpan di browser, mobile app, atau repository frontend.
Video liveness dijalankan melalui SDK session agar proses kamera dan payload frame tetap konsisten.

Web / Vanilla JS

1. Install / Import

<script type="module">
  import { Ogi } from 'https://cdn.orbitglobalinformasi.com/sdk/v1/ogi.js';
</script>

Atau lewat package manager:

npm install @orbit-global-informasi/sdk-web

import { Ogi } from '@orbit-global-informasi/sdk-web';

2. Inisialisasi

const ogi = new Ogi({
  publishableKey: 'pk_test_...',
  brand: {
    name: 'Nama Bisnis',
    primaryColor: '#155EEF',
    language: 'id'
  }
});

3. OCR KTP

await ogi.createSession({
  flow: 'ocr_only',
  externalUserId: 'user_12345'
});

const ocr = await ogi.extractKtp(ktpFile);
console.log(ocr.document_result.ocr_result);

4. Face Liveness

await ogi.createSession({
  flow: 'liveness_only',
  externalUserId: 'user_12345'
});

await ogi.startCamera();

const liveness = await ogi.runVideoLiveness({
  frameCount: 5,
  intervalMs: 350
});
console.log(liveness.liveness_result);

Untuk selfie statis:

const liveness = await ogi.checkFaceLiveness(selfieFile);
console.log(liveness.liveness_result);

5. Face Match

await ogi.createSession({
  flow: 'face_match',
  externalUserId: 'user_12345'
});

const match = await ogi.matchFace(ktpFile, selfieFile);
console.log(match.face_match_result);

6. Identity Verification

await ogi.createSession({
  flow: 'identity_verification',
  externalUserId: 'user_12345'
});

await ogi.extractKtp(ktpFile);
await ogi.runVideoLiveness();
await ogi.matchFace(ktpFile, selfieFile);

const session = await ogi.complete();
console.log(session.status);

7. NIK Validation via Backend

NIK validation menggunakan Secret Key sehingga pemanggilannya berada di backend. Aplikasi browser mengirim data hasil OCR atau input pengguna ke backend internal, lalu backend meneruskan permintaan ke Orbit Global Informasi.

Frontend:

const ocr = await ogi.extractKtp(ktpFile);

const nikResult = await fetch('/api/identity/validate-nik', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    nik: ocr.document_result.ocr_result.nik,
    name: ocr.document_result.ocr_result.name,
    date_of_birth: ocr.document_result.ocr_result.date_of_birth
  })
}).then((response) => response.json());

Backend Node.js:

import { Ogi } from '@orbit-global-informasi/sdk-core';

const ogiServer = new Ogi({ secretKey: process.env.OGI_SECRET_KEY });

app.post('/api/identity/validate-nik', async (req, res) => {
  const result = await ogiServer.validateNik({
    nik: req.body.nik,
    name: req.body.name,
    date_of_birth: req.body.date_of_birth
  });

  res.json(result);
});

React

1. Install / Import

npm install @orbit-global-informasi/sdk-react

import React from 'react';
import { createOgiReact } from '@orbit-global-informasi/sdk-react';

const { OgiProvider, useOgiFlow } = createOgiReact(React);

2. Inisialisasi Provider

function App() {
  return (
    <OgiProvider publishableKey="pk_test_...">
      <KycScreen />
    </OgiProvider>
  );
}

3. OCR KTP

function OcrOnlyScreen() {
  const { createSession, extractKtp } = useOgiFlow();

  async function run(file) {
    await createSession({ flow: 'ocr_only', externalUserId: 'user_12345' });
    const result = await extractKtp(file);
    console.log(result.documentResult.document_result);
  }
}

4. Face Liveness

function LivenessOnlyScreen() {
  const { createSession, checkFaceLiveness, submitVideoLiveness } = useOgiFlow();

  async function runSelfie(selfieFile) {
    await createSession({ flow: 'liveness_only', externalUserId: 'user_12345' });
    const result = await checkFaceLiveness(selfieFile);
    console.log(result.livenessResult.liveness_result);
  }

  async function runVideo(frames) {
    await createSession({ flow: 'liveness_only', externalUserId: 'user_12345' });
    const result = await submitVideoLiveness(frames);
    console.log(result.livenessResult.liveness_result);
  }
}

5. Face Match

function FaceMatchOnlyScreen() {
  const { createSession, matchFace } = useOgiFlow();

  async function run(ktpFile, selfieFile) {
    await createSession({ flow: 'face_match', externalUserId: 'user_12345' });
    const result = await matchFace(ktpFile, selfieFile);
    console.log(result.faceMatchResult.face_match_result);
  }
}

6. Kamera

React SDK tidak bergantung pada satu komponen kamera tertentu. Aplikasi dapat menggunakan getUserMedia, komponen kamera internal, atau wrapper Web SDK. Method submitVideoLiveness(frames) menerima File[] hasil capture kamera.

7. NIK Validation via Backend

Gunakan pola backend yang sama seperti Web SDK. Komponen React cukup mengirim data KTP ke endpoint internal, sementara Secret Key tetap berada di server.

async function validateNikFromOcr(ocrResult) {
  const response = await fetch('/api/identity/validate-nik', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
      nik: ocrResult.nik,
      name: ocrResult.name,
      date_of_birth: ocrResult.date_of_birth
    })
  });

  return response.json();
}

React Native

1. Install / Import

npm install @orbit-global-informasi/sdk-react-native

import React from 'react';
import { View, Text, Pressable } from 'react-native';
import { createOgiReactNative } from '@orbit-global-informasi/sdk-react-native';

const { OgiProvider, useOgiNativeFlow } = createOgiReactNative({
  React,
  View,
  Text,
  Pressable
});

2. Inisialisasi Provider

export default function App() {
  return (
    <OgiProvider publishableKey="pk_test_...">
      <KycScreen />
    </OgiProvider>
  );
}

3. OCR KTP

function OcrOnlyScreen() {
  const { createSession, extractKtp } = useOgiNativeFlow();

  async function run() {
    await createSession({ flow: 'ocr_only', externalUserId: 'user_mobile_123' });
    await extractKtp({
      uri: 'file:///path/to/ktp.jpg',
      name: 'ktp.jpg',
      type: 'image/jpeg'
    });
  }
}

4. Face Liveness

function LivenessOnlyScreen() {
  const { createSession, checkFaceLiveness, submitVideoLiveness } = useOgiNativeFlow();

  async function runSelfie() {
    await createSession({ flow: 'liveness_only', externalUserId: 'user_mobile_123' });
    await checkFaceLiveness({
      uri: 'file:///path/to/selfie.jpg',
      name: 'selfie.jpg',
      type: 'image/jpeg'
    });
  }

  async function runVideo() {
    await createSession({ flow: 'liveness_only', externalUserId: 'user_mobile_123' });

    const frames = [
      { uri: 'file:///path/to/frame-1.jpg', name: 'frame-1.jpg', type: 'image/jpeg' },
      { uri: 'file:///path/to/frame-2.jpg', name: 'frame-2.jpg', type: 'image/jpeg' },
      { uri: 'file:///path/to/frame-3.jpg', name: 'frame-3.jpg', type: 'image/jpeg' }
    ];

    const result = await submitVideoLiveness(frames);
    console.log(result.livenessResult.liveness_result);
  }
}

5. Face Match

function FaceMatchOnlyScreen() {
  const { createSession, matchFace } = useOgiNativeFlow();

  async function run() {
    await createSession({ flow: 'face_match', externalUserId: 'user_mobile_123' });

    await matchFace(
      { uri: 'file:///path/to/ktp.jpg', name: 'ktp.jpg', type: 'image/jpeg' },
      { uri: 'file:///path/to/selfie.jpg', name: 'selfie.jpg', type: 'image/jpeg' }
    );
  }
}

6. Kamera

React Native SDK dapat digunakan bersama VisionCamera, Expo Camera, atau library kamera internal. Ambil beberapa frame dari kamera, lalu kirim frame tersebut melalui submitVideoLiveness().

7. NIK Validation via Backend

NIK validation diproses melalui backend aplikasi. Mobile app mengirim data OCR atau identifier user ke API internal, lalu backend menjalankan validateNik() menggunakan Secret Key.

async function validateNikFromMobile(ocrResult) {
  const response = await fetch('https://api.example.com/identity/validate-nik', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
      nik: ocrResult.nik,
      name: ocrResult.name,
      date_of_birth: ocrResult.date_of_birth
    })
  });

  return response.json();
}

PHP

PHP SDK digunakan pada backend untuk membuat SDK session, menjalankan REST API server-to-server, memvalidasi NIK, dan memverifikasi webhook signature. SDK ini tidak membuka kamera pengguna; pengalaman kamera dijalankan melalui Web, React, atau React Native SDK.

1. Install / Import

composer require orbit-global-informasi/sdk-php

require_once 'vendor/autoload.php';

use OrbitGlobalInformasi\Ogi;

2. Inisialisasi

$ogi = new Ogi([
    'secretKey' => 'sk_test_...',
    'publishableKey' => 'pk_test_...'
]);

3. Membuat SDK Session

$session = $ogi->createSession([
    'flow' => 'identity_verification',
    'external_user_id' => 'user_12345'
]);

echo $session['client_token'];

4. OCR KTP

$ocr = $ogi->extractKtp('/path/to/ktp.jpg');
print_r($ocr['ocr_result']);

5. Face Liveness Selfie

$liveness = $ogi->checkFaceLiveness('/path/to/selfie.jpg');
echo $liveness['liveness_score'];

6. Video Liveness Internal

Untuk pengalaman kamera production, gunakan Web, React, atau React Native SDK. Method PHP ini tersedia untuk backend yang sudah menerima frame kamera atau kebutuhan pengujian internal.

$result = $ogi->checkVideoLiveness([
    '/path/to/frame-1.jpg',
    '/path/to/frame-2.jpg',
    '/path/to/frame-3.jpg'
]);

print_r($result);

7. Face Match

$match = $ogi->matchFaces('/path/to/ktp.jpg', '/path/to/selfie.jpg');
echo $match['face_match']['matched'] ? 'matched' : 'not matched';

8. NIK Validation

$nik = $ogi->validateNik([
    'nik' => '3276000000000001',
    'name' => 'BUDI SANTOSO',
    'date_of_birth' => '17-08-1945'
]);

print_r($nik['result']);

9. Webhook Signature

$rawPayload = file_get_contents('php://input');
$signature = $_SERVER['HTTP_X_OGI_SIGNATURE'] ?? '';
$valid = $ogi->verifyWebhookSignature($rawPayload, $signature, 'whsec_...');

if (!$valid) {
    http_response_code(400);
    exit;
}

Service Modular

Setiap service dapat digunakan secara terpisah sesuai paket yang aktif di akun. Pilih flow yang sesuai, jalankan method service yang diperlukan, lalu panggil complete() jika session perlu ditutup dan webhook perlu dipicu.

Service	SDK Client	Backend/PHP	Catatan
OCR KTP	`extractKtp(file)`	`extractKtp(path)`	Berjalan dalam flow `ocr_only`.
Face liveness selfie	`checkFaceLiveness(file)`	`checkFaceLiveness(path)`	Cocok jika aplikasi sudah punya capture selfie sendiri.
Video liveness kamera	`runVideoLiveness()` atau `submitVideoLiveness(frames)`	`checkVideoLiveness(paths)` untuk internal test	Untuk production client, utamakan SDK frontend/mobile.
Face match	`matchFace(idImage, selfieImage)`	`matchFaces(idPath, selfiePath)`	Berjalan dalam flow `face_match`.
NIK validation	Panggil backend internal	`validateNik(payload)`	Secret Key hanya disimpan di backend.
Complete session	`complete()`	`completeSession(sessionId)`	Opsional untuk menandai sesi selesai dan memicu webhook.

Catatan Platform

Web SDK menyediakan capture kamera langsung. React dan React Native menyediakan hook agar aplikasi dapat memakai komponen kamera yang sudah ada, sedangkan PHP SDK berfokus pada backend dan server-to-server API.

Siap mengevaluasi?

Hubungi tim solusi kami untuk akses evaluasi teknis dan diskusi integrasi.

Diskusikan Kebutuhan Kembali ke ringkasan