დოკუმენტაცია

API დოკუმენტაცია

ყველაფერი, რაც გჭირდებათ OTP ვერიფიკაციის თქვენს აპლიკაციაში ინტეგრაციისთვის.

სწრაფი დაწყება
გახდით მზად 5 წუთში
1

ნაბიჯი 1: შექმენით ანგარიში

დარეგისტრირდით უფასოდ verify.ge/register

2

ნაბიჯი 2: მიიღეთ API გასაღები

გადადით API გასაღებების სექციაზე თქვენს დაფაზე და შექმენით ახალი გასაღები. შეინახეთ იგი უსაფრთხოდ!

3

ნაბიჯი 3: დააყენეთ SDK (არასავალდებულო)

TypeScript/JavaScript პროექტებისთვის, დააყენეთ ჩვენი ოფიციალური NPM პაკეტი:

კოდის მაგალითები

🇬🇪 ოფიციალური TypeScript SDK

@smart-pay-chain/otp - პირველი ქართული NPM პაკეტი OTP-სთვის

ინსტალაცია

npm install @smart-pay-chain/otp

სწრაფი დაწყება

import { OtpClient, OtpChannel } from '@smart-pay-chain/otp';

// Initialize client
const client = new OtpClient({
  apiKey: process.env.OTP_API_KEY,
  autoConfig: true, // Auto-fetch server configuration
});

// Send OTP
const result = await client.sendOtp({
  phoneNumber: '+995568000865',
  channel: OtpChannel.SMS,
  ttl: 300, // 5 minutes
  length: 6, // 6-digit code
});

console.log('OTP sent!', result.requestId);

// Verify OTP
const verification = await client.verifyOtp({
  requestId: result.requestId,
  code: '123456', // User-entered code
  ipAddress: req.ip, // Optional but recommended
});

if (verification.success) {
  console.log('Phone verified! ✓');
  // Proceed with authentication
}

მთავარი ფუნქციები

  • სრული TypeScript მხარდაჭერა ტიპების განმარტებებით
  • ჩაშენებული ხელახალი მცდელობის ლოგიკა და შეცდომების დამუშავება
  • ტესტ რეჟიმი დეველოპმენტისთვის (SMS-ს გადასახადის გარეშე)
  • ავტომატური იდემპოტენტურობის გასაღებები
  • React Native და მობილური აპების მხარდაჭერა
შეცდომების დამუშავება
import {
  InvalidOtpError,
  OtpExpiredError,
  RateLimitError,
} from '@smart-pay-chain/otp';

try {
  const result = await client.verifyOtp({ requestId, code });
} catch (error) {
  if (error instanceof InvalidOtpError) {
    console.log('Wrong code. Please try again.');
  } else if (error instanceof OtpExpiredError) {
    console.log('OTP expired. Request a new one.');
  } else if (error instanceof RateLimitError) {
    console.log('Too many attempts. Please wait.');
  }
}
ტესტ რეჟიმი
import { TEST_PHONE_NUMBERS, TEST_OTP_CODE } from '@smart-pay-chain/otp';

// Check if test mode is enabled
const testMode = await client.isTestMode();

// Use test phone numbers (no SMS charges)
const result = await client.sendOtp({
  phoneNumber: TEST_PHONE_NUMBERS.SUCCESS, // +995568000865
});

// In test mode, OTP is always: 123456
const verification = await client.verifyOtp({
  requestId: result.requestId,
  code: TEST_OTP_CODE, // '123456'
});

API რეფერენსი

ძირითადი URL
https://api.verify.ge/api/v1
აუთენტიფიკაცია

ყველა API მოთხოვნა მოითხოვს აუთენტიფიკაციას API გასაღების გამოყენებით. ჩართეთ თქვენი API გასაღები X-API-Key ჰედერში:

X-API-Key: your_api_key_here
ენდფოინთები
POST/otp/sendOTP-ს გაგზავნა ტელეფონის ნომერზეPrimary
POST/otp/verifyOTP კოდის ვერიფიკაციაPrimary
GET/otp/{requestId}OTP მოთხოვნის სტატუსის მიღება
GET/keysყველა API გასაღების სია
POST/keysახალი API გასაღების შექმნა
DELETE/keys/{keyId}API გასაღების გაუქმება
GET/tierტარიფის ინფორმაციის მიღება
GET/billing/balanceბალანსის მიღება

მზად ხართ ინტეგრაციის დასაწყებად?