توثيق API

نظرة عامة على API

الرابط الأساسي: https://pth.bz

المسار

الطلب

Body JSON:

{
                                                                          "url": "https://example.com/landing?utm_source=newsletter"
                                                                        }

الاستجابة

200 OK:

{
                                                                          "short_url_301": "https://pth.bz/AbC1234",
                                                                          "short_url_js": "https://pth.bz/i/AbC1234",
                                                                          "qr_301_png_url": "https://pth.bz/?qr=AbC1234",
                                                                          "qr_js_png_url": "https://pth.bz/?qi=AbC1234"
                                                                        }

اختيار التحويل

رموز QR (PNG)

• For 301: /?qr=CODE
• For interstitial: /?qi=CODE
• حجم اختياري بالبكسل: (200–2048) &px=640

<img src="https://pth.bz/?qr=AbC1234&px=640" alt="QR" />

استجابات الأخطاء

{
                                                                          "error": "Too many requests"
                                                                        }

القيود والقواعد

• الحد: 30 طلبًا / 10 دقائق / IP.
• http:// و https:// فقط.
• أقصى طول للرابط: 2000 حرفًا.
• JSON فقط: Content-Type: application/json.

أمثلة

curl -X POST "https://pth.bz/api/shorten" \
                                                                          -H "Content-Type: application/json" \
                                                                          -d '{"url": "https://example.com"}'

const res = await fetch('https://pth.bz/api/shorten', {
                                                                          method: 'POST',
                                                                          headers: { 'Content-Type': 'application/json' },
                                                                          body: JSON.stringify({ url: 'https://example.com' })
                                                                        });
                                                                        const data = await res.json();
                                                                        console.log(data.short_url_301, data.short_url_js);

import requests

                                                                        r = requests.post('https://pth.bz/api/shorten', json={'url': 'https://example.com'})
                                                                        print(r.status_code, r.json())

SDK

pip install pthbz

from pthbz import PthBzClient

                                                                        client = PthBzClient(base_url="https://pth.bz")
                                                                        res = client.shorten("https://example.com/landing?utm_source=newsletter")
                                                                        print(res.short_url_301)   # https://pth.bz/AbC1234
                                                                        print(res.short_url_js)    # https://pth.bz/i/AbC1234
                                                                        print(res.qr_301_png_url)  # https://pth.bz/?qr=AbC1234
                                                                        print(res.qr_js_png_url)   # https://pth.bz/?qi=AbC1234
                                                                        client.close()

import asyncio
                                                                        from pthbz import AsyncPthBzClient

                                                                        async def main():
                                                                            async with AsyncPthBzClient(base_url="https://pth.bz") as client:
                                                                                res = await client.shorten("https://example.com")
                                                                                print(res.short_url_301)

                                                                        asyncio.run(main())