مستندات تترا

پینگ

تأیید اتصال و بررسی وضعیت توکن دسترسی به گیت‌وی

مقدمه

سرویس Ping یک endpoint تأیید زنده‌بودن است که بررسی می‌کند YOUR_GATEWAY_TOKEN معتبر بوده، کسب‌وکارتان در گیت‌وی فعال است و IP شما مجاز است. پیش از اجرای هر جریان کالابرگ، با یک فراخوانی ساده به این سرویس از صحت تنظیمات خود مطمئن شوید.

توجه:

این سرویس نیازی به هدر Idempotency-Key ندارد و هیچ تغییری در سیستم ایجاد نمی‌کند.


۱. پینگ (Ping)

Endpoint

POST /gateway/v1/ping

هدرها

هدرمقدارالزامی
Acceptapplication/jsonبله
AuthorizationBearer {gateway_token}بله

پارامترها

این سرویس بدنه‌ای دریافت نمی‌کند.

نمونه کد

php
<?php
$ch = curl_init('https://back.tetra.land/gateway/v1/ping');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Accept: application/json',
    'Authorization: Bearer YOUR_GATEWAY_TOKEN',
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);

امتحان کنید

POST/gateway/v1/pingامتحان کنید

پاسخ‌ها

json
{
  "data": {
    "business_id": 12,
    "business_name": "نام کسب‌وکار شما",
    "environment": "sandbox"
  },
  "meta": {
    "status": true,
    "message": "Operation completed successfully.",
    "tracking_code": "260808_XXXXXX"
  }
}