AS216394 · WireShield

Dokümantasyon

Kurulum, bağlantı ve günlük operasyon rehberleri.

WAF Bayi API'si

Bayi API'si, Web Protection'ın birçok müşterisini kendi portalınızdan ya da faturalama sisteminizden yönetir. Yalnızca sizin açtığınız müşterileri görürsünüz. Bayi hesabını WireShield talep üzerine açar: bize ulaşın.

Bağlanma

  • Adres: https://waf.wireshield.network/api/v1
  • Token: bayi panelinde API Ayarları. wsapi_ ile başlar ve bir kez gösterilir.
  • Başlık: Authorization: Bearer wsapi_…
  • Hatalar, limitler ve biçimler WAF Müşteri API'si ile aynıdır. Limitte null sınırsız, 0 hiç yok demektir.

Tipik akış

  1. Satış: paketle POST /customers, ardından POST /customers/{id}/domains. Yanıttaki dns hedefini müşteriye gösterin.
  2. DNS: müşteri DNS'ini değiştirir. GET /customers/{id}/domains/{domain_id}/dns-check ne zaman geldiğini söyler; sertifika kendiliğinden alınır (ya da POST …/ssl ile hemen istenir).
  3. Giriş: POST /customers/{id}/login-link, WAF paneline parolasız açan tek kullanımlık bir adres döner (15 dakika). Tıklama anında üretin.
  4. Faturalama: ay sonunda GET /usage?month=YYYY-MM.
  5. Ödeme yoksa: POST /customers/{id}/suspend, ödenince …/unsuspend. DELETE /customers/{id} hizmeti bitirir (?permanent=true her şeyi siler).

Paketler ve müşteriler

ÇağrıNe yapar
GET /plansVerebileceğiniz paketler, limitleriyle (sites, custom_rules, rate_limit_rules, captcha_monthly, captcha_keys) ve özellikleriyle
POST /customersMüşteri açar: email, name, plan_id, isteğe bağlı password ya da send_invite
GET /customers, GET /customers/{id}Listeler, okur
PUT /customers/{id}Paketi ({"plan_id": "…"}) ve limitleri değiştirir. Hesap aynı kalır, anahtarları silinmez
DELETE /customers/{id}Hizmeti bitirir
POST /customers/{id}/login-linkTek kullanımlık giriş adresi
POST /customers/{id}/suspend · unsuspendMüşteriyi kapatır / açar
POST /api/v1/customers

{"email": "ali@example.com", "name": "Example Ltd", "plan_id": "f980842a-e67c-4d9a-9456-65e4f6ffdc95", "send_invite": false}

Bir e-posta adresinin WAF panelinde yalnızca bir hesabı olabilir. Bayiniz dışında açılmış hesabı olan bir müşteri yeniden açılamaz: o hesabı sizin altınıza taşımamızı isteyin.

Müşterinin siteleri

ÇağrıNe yapar
GET /customers/{id}/locationsPaketin seçmeye izin verdiği lokasyonlar (enabled: false = en uygun düğüm kullanılır)
POST /customers/{id}/domainsSite ekler: domain, isteğe bağlı backend_servers (address, port, weight), location_id, www_redirect (none, www_to_main, main_to_www). Yanıtta dns vardır
GET /customers/{id}/domains, …/{domain_id}Listeler, okur
GET …/{domain_id}/dns-checkDNS geldi mi
POST …/{domain_id}/sslSertifikayı hemen ister
POST …/{domain_id}/backends, DELETE …/backends/{backend_id}Kaynak sunucular (en çok 20)
PUT …/{domain_id}/waf?enabled=trueKoruma açık / kapalı
DELETE …/{domain_id}Siteyi siler

Kullanım

GET /usage?month=YYYY-MM ayın bütün müşterilerini tek çağrıda verir: paket, site sayısı, traffic (requests, blocked, challenged, bytes) ve captcha_verifications. GET /customers/{id}/usage aynısını tek müşteri için verir.

wsCAPTCHA

ÇağrıNe yapar
GET /customers/{id}/captchaAnahtarlar ve bu ayın kullanımı (pakete göre)
POST /customers/{id}/captcha/keysAnahtar oluşturur (name, domains). Yanıtta site anahtarı ve bir kez gösterilen gizli anahtar vardır
PUT /customers/{id}/captcha/keys/{key_id}Ad, alan adları, açık/kapalı
POST /customers/{id}/captcha/keys/{key_id}/secretYeni gizli anahtar üretir
GET …/{key_id}/stats?period=24h ya da 7dSayılar
GET …/{key_id}/events?limit=100Doğrulama kaydı
DELETE …/{key_id}Anahtarı siler

Doğrulamanın kendisi wsCAPTCHA entegrasyon rehberinde anlatılır.

Bu rehberle ilgili sorunuz mu var?
Teknik ekibe sorun