راهنمای API برای برنامه‌نویسان

احراز هویت

در پنل، بخش API و اتصال به نرم‌افزارها، یک اتصال با پیج‌ها و دسترسی‌های لازم بسازید. در هر درخواست، کلید را در هدر Authorization با روش Bearer ارسال کنید. کلید یک سال اعتبار دارد و از پنل قابل تغییر یا لغو است.

curl 'https://highfollower.com/api/v1/pages' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Accept: application/json'

مسیرهای API

ارسال پاسخ

برای پاسخ دایرکت یا کامنت، message متنی با حداکثر ۱۰۰۰ نویسه بفرستید. در وضعیت uncertain دوباره ارسال نکنید؛ ابتدا نتیجه را در صندوق ورودی بررسی کنید.

curl -X POST 'https://highfollower.com/api/v1/pages/12/conversations/CONVERSATION_KEY/replies' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"message":"Hello! How can we help?"}'

وبهوک اختصاصی

آدرس و رویدادها را در اتصال تنظیم کنید و از ارسال آزمایشی استفاده کنید. هر وبهوک شامل id، type، api_version، occurred_at، platform_page_id، platform و data است. پیام و کامنت، ورودی و خروجی را پوشش می‌دهند. رویداد synced علامت دریافت دوباره فهرست از API است.

import hashlib, hmac, json, time

def verify_webhook(raw_body, headers, secret):
    timestamp = headers["X-HighFollower-Timestamp"]
    if abs(time.time() - int(timestamp)) > 300:
        raise ValueError("Expired webhook")
    digest = hmac.new(
        secret.encode(), timestamp.encode() + b"." + raw_body,
        hashlib.sha256,
    ).hexdigest()
    if not hmac.compare_digest(
        "sha256=" + digest, headers["X-HighFollower-Signature"]
    ):
        raise ValueError("Invalid signature")
    return json.loads(raw_body)

# Deduplicate the verified payload["id"] in your database.
# Return 2xx after durably accepting the event.

محدودیت‌ها و خطاها