Genel bakış
Herkese açık HTTP API, `/api/v1` altında URL ile sürümlenir. Uyumu bozan değişiklikler yeni bir sürümde gelir. Kaynak yanıtları her zaman tipli API Resources üzerinden geçer, asla ham Eloquent modelleri olarak dönmez.
Hatalar `type`, `title`, `status`, `detail` ve `traceId` içeren RFC 7807 `application/problem+json` kullanır. `X-Request-Id` yanıt başlığıyla ilişkilendir.
Kurallar
Temel yol `/api/v1`
Sürüm adreste
İmleçli sayfalama
`?cursor=...&limit=50`
Yazma isteklerinde Idempotency-Key
UUIDv4, 24 saatlik tekilleştirme penceresi
JSON istek/yanıt gövdeleri
Accept başlığı: application/json
Yaygın kalıplar
İmleçle listeleme
`meta.hasMore` true olduğu sürece `meta.nextCursor`'ı izle. Ofset sayfalamalı istemciler icat etme.
GET /api/v1/<resource>?limit=50&cursor=<opaque>
problem+json'ı işle
4xx/5xx durumunda problem belgesini ayrıştır. `title`/`detail` alanlarını operatörlere göster; `traceId`'yi destek talepleri için sakla.
{
"type": "https://...",
"title": "Validation failed",
"status": 422,
"detail": "...",
"traceId": "..."
}Idempotent oluşturma
Her mantıksal işlem için yeni bir UUIDv4 üret. Aktarım hatalarını aynı anahtarla yeniden dene; yeni bir mantıksal oluşturma için yeni anahtar başlat.
Bir kişi için akış başlatın
Yayındaki bir akışı mağazanızdan, bir formdan ya da Zapier'den tek bir kişiye gönderin. Akış kişinin son sohbetinde çalışır; `variables` akışa `{{ trigger.variables.name }}` olarak ulaşır.
POST /api/v1/workspaces/<workspace>/automations/<id>/start
{ "contact_id": "<contact id>", "variables": { "coupon": "WELCOME10" } }Anahtarı dar tutun
Bir anahtar yalnızca kişilerle ya da gelen kutusuyla sınırlanabilir. Bir entegrasyona yalnızca ihtiyacı olanı verin; `GET /api/v1/auth/me` bağlantı testi için her anahtara yanıt verir.
Kapsam notları
Not
API neleri kapsıyor
Çalışma alanına bağlı ürün kaynakları (kişiler, otomasyonlar, açıldığı ölçüde gelen kutusu okuma/yazmaları, izin verilen yerlerde faturalama okumaları vb.). Kaynak listesi ürünle birlikte genişler: sözleşme yüzeyi olarak Yardım'ı ve bu başvuru kaynağını esas alın.
İpucu
Rehberler ve API
Yorumdan DM'e ve içerik üreticisi büyüme tarifleri Yardım rehberlerinde. Mağazanızın ya da ara katmanınızın kişileri eklemesi veya otomasyonları programla başlatması gerektiğinde API'yi kullanın.
Bu rehber işine yaradı mı?
Kütüphanede daha fazlasına göz at
Bunu uygulamaya
koymaya hazır mısın?
İlk otomasyonunu ücretsiz kurmaya başla. Kredi kartı gerekmez. Kanalını bağla ve dakikalar içinde yayına al.