Contix Pro, kapsamlı REST API anahtarları ve imzalı webhook'lar sunar; böylece diğer sistemler Contix'te iş başlatabilir ve iş bittiğinde haberdar olabilir. İkisi de yalnızca bir yönetici bunları oluşturduktan sonra çalışır.
Nerede bulunur: ARN Contix → Sistem → Entegrasyonlar. Üst kısımda proje bağlamını seçin ve Entegrasyon çalışma alanını aç düğmesine tıklayın. Aynı ekrandaki Google Search Console bağlantısı Google Search Console ile performansı izleyin makalesinde anlatılmaktadır.

REST API anahtarı oluşturun
- 1. REST API Anahtarları altında bir Ad girin.
- Proje bağlaması altında Tüm projeler seçeneğini veya tek bir projeyi seçin. Tek bir projeye bağlı anahtar yalnızca o projeyi (
project_id) belirten isteklerle çalışır ve proje oluşturamaz. Bağlı bir anahtarGET /statusçağrısını da yapabilir;GET /projectsise yalnızca kendi projesini döndürür. - Anahtarın ihtiyaç duyduğu Kapsamlar seçeneklerini işaretleyin.
- API anahtarı oluştur düğmesine tıklayın.
Yeni anahtar yalnızca bir kez gösterilir: hemen kopyalayın ve güvenli bir yerde saklayın. Contix anahtarları yalnızca tuzlanmış hash olarak saklar ve bir anahtarı tekrar gösteremez.
Anahtar tablosunda Ad, anahtar Ön Ek, Kapsamlar ve anahtarın Son kullanım zamanı listelenir. Bir anahtarı durdurmak için İptal et düğmesine tıklayın; bu anahtarı kullanan istekler o andan itibaren reddedilir.
Kapsamlar ve uç noktalar
Tüm uç noktalar /wp-json/contix/v1/ altındadır. Anahtarı Authorization başlığında Bearer ve ardından anahtar olacak şekilde gönderin.
| Yöntem ve uç nokta | Kapsam | Ne yapar |
|---|---|---|
GET /status | system.read | Contix sürümünü, şemayı ve çalışma ortamının duraklatılıp duraklatılmadığını döndürür |
GET /projects | projects.read | Projeleri listeler; tek bir projeye bağlı anahtar için yalnızca o projeyi |
POST /projects | projects.write | Bir proje oluşturur (name, language, region, brand_summary, content_goal) |
GET /projects/{project_id}/topics | topics.read | Bir projenin konularını listeler |
POST /projects/{project_id}/topics | topics.write | Bir konu oluşturur (keyword, secondary_keywords, content_type, search_intent, audience, language, region, goal, priority) |
POST /pipeline/start | pipeline.write | Bir çalıştırma başlatır (project_id, topic_id, automatic veya guided olarak mode) |
GET /pipeline/{run_id}?project_id={project_id} | pipeline.read | Bir çalıştırmanın durumunu döndürür |
GET /projects/{project_id}/topics/{topic_id}/results | results.read | Bir konunun makale taslağı, analiz ve yayınlama paketi gibi kayıtlı sonuçlarını döndürür |
GET /projects/{project_id}/jobs | jobs.read | Bir projenin son işlerini listeler |
GET /projects/{project_id}/connectors | connectors.read | Bir projenin bağlayıcılarını listeler |
Her anahtar dakikada 120 istekle sınırlıdır. Sık karşılaşılan yanıtlar:
| Durum | Anlamı |
|---|---|
| 401 | Anahtar eksik, geçersiz veya iptal edilmiş |
| 403 | Anahtar bu kapsamı vermiyor, başka bir projeye bağlı ya da projeye bağlı bir anahtar proje oluşturmaya çalıştı |
| 409 | Çalıştırma başlatılamadı; nedeni mesajda belirtilir |
| 422 | Proje veya konu oluşturulamadı; alanları kontrol edin |
| 429 | Anahtar dakikada 120 istek sınırını aştı |
Kimliği doğrulanmış her istek Contix günlüğüne kaydedilir.
İmzalı webhook oluşturma
- 3. İmzalı Webhook'lar altında bir Ad ve HTTPS uç noktası girin.
- İstediğiniz Olaylar seçeneklerini işaretleyin:
job.completed,job.failed,pipeline.completed,pipeline.failed,publish.completedveyapublish.failed. - Webhook oluştur düğmesine tıklayın.
İmzalama sırrı yalnızca bir kez gösterilir: hemen kopyalayın. Yalnızca herkese açık HTTPS adresleri kabul edilir; özel ve ayrılmış ağ adresleri reddedilir.
Webhook tablosu olayları, başarılı ve başarısız teslimat sayısını ve son durumu gösterir. Bir webhook'u kaldırmak için Sil düğmesine tıklayın.
Webhook teslimatını doğrulama
Contix her olayı şu başlıklarla JSON POST olarak gönderir:
| Başlık | İçerik |
|---|---|
X-Contix-Event | Olay türü, örneğin pipeline.completed |
X-Contix-Delivery | Sabit bir teslimat kimliği; daha önce işlediğiniz bir teslimatı yok saymak için kullanın |
X-Contix-Timestamp | Teslimat zamanı, Unix zaman damgası olarak |
X-Contix-Signature | v1= ve ardından imza |
İmza; zaman damgası, bir nokta ve ham istek gövdesinin (timestamp.body), anahtar olarak imzalama sırrınız kullanılarak hesaplanan onaltılık HMAC-SHA256 değeridir. İsteğe güvenmeden önce imzayı kendi tarafınızda hesaplayıp başlıkla karşılaştırın.
Uç noktanız 2xx durum koduyla yanıt verdiğinde teslimat başarılı sayılır. Ağ hataları ile 429 veya 5xx durumlu yanıtlar kuyruk üzerinden yeniden denenir. Yönlendirmeler izlenmez.