Semaphore'u araçlarınıza bağlayın

Dış olayın önceden tanımlı Görev Şablonu seçip istek değerlerini kabul edilen girdilere eşlemesi gerekiyorsa webhook entegrasyonu kullanın. Uygulamanın görev başlatıp durum okuma gibi daha açık kaynak ve yürütme akışına ihtiyacı varsa REST API kullanın. İkisinde de otomasyon Semaphore'un yapılandırılmış yürütme modelinden geçer. Çağıranın göndermesi ve takip etmesi gerekenlere göre seçin.

Proje takma adı, entegrasyonlarındaki yapılandırılmış eşleştiricileri değerlendirir ve istekle eşleşenleri başlatabilir. Entegrasyona özgü takma ad, eşleştiricilerini değerlendirmeden doğrudan tek entegrasyona gider. Çalıştırmayı dal veya olay türü kuralının denetlemesini bekliyorsanız bu ayrım önemlidir. Aynı filtrenin her takma ad yolunda geçerli olduğunu varsaymak yerine uç noktayı bilinçli seçin; eşleşen ve eşleşmeyen verileri test edin.

İlgili istek başlıklarını veya gövde alanlarını okumak ve belgelenmiş ortam değerleri ya da görev parametrelerine eşlemek için çıkarıcıları yapılandırın. Parametre hedefleri şablonun kabul ettiği istemlerle uyumlu olmalıdır. Eşlemeyi belirli tutun: sürüm, sınırsız komut parçasına değil amaçlanan girdiye dönüşmelidir. Anlamı doğrulama gerektiriyorsa değeri otomasyonda doğrulayın; üretimden önce eksik veya beklenmedik alanları test edin.

API tokeni, Semaphore kullanıcısının izinleriyle hareket eder. Proje erişimi entegrasyonun amaçlanan işlemleriyle eşleşen kimlik kullanın ve tokeni çağıranın sakladığı her yerde koruyun. API, proje yetkilendirmesini atlatma yolu değildir. Webhook entegrasyonlarında belgelenmiş istek kimlik doğrulamasını ve uç nokta erişimini de bilinçli yapılandırın. Çağıran kimlik doğrulamasını, oluşan görevin altyapıya erişmek için kullandığı kimlik bilgilerinden ayrı tutun.

REST API akışında belgelenmiş işlemin döndürdüğü görev kimliğini saklayın ve durum ile çıktıyı incelemek için ilgili API yöntemlerini kullanın. Başarılı istek, yürütmenin istendiği anlamına gelir; altyapı işinin başarıyla bittiği anlamına gelmez. Servisiniz istek hatalarını, bekleyen veya çalışan görevleri ve tamamlanmış sonuçları ayırt etmelidir. Gerçek yürütme kayıtlarını incelemeleri gerektiğinde mühendisleri göreve yönlendirin.

Tam olarak bir kez yürütme veya kalıcı teslimat garantisi varsaymayın. İlk istek Semaphore'a ulaşsa bile dış servis zaman aşımından sonra yeniden deneyebilir. Yinelenen istek yönetimini ve yeniden deneme kararlarını işlemin sonuçlarına göre tasarlayın; uygun olduğunda temel otomasyonu idempotent yapın. Mühendislerin tekrarlı veya belirsiz teslimatı anlaması için kaynak olay ile servisin izlediği çalıştırma arasındaki ilişkiyi saklayın.

Bu sitedeki başvuru, Semaphore sürümüyle yayımlanan Swagger/OpenAPI belgesini görüntüler; görülen işlemler, yollar ve şemalar elle yazılmış özete değil belirli sürüme karşılık gelir. /api-docs/ adresinde kaynağa göre gezinin veya istemci üretiyorsanız ham belgeyi okuyun. Uç noktalar ve istek şemaları sürümler arasında değişebileceğinden gerçekten çalıştırdığınız sürümün belirtimini kontrol edin.

Çağıran sistem Semaphore örneğinize erişmelidir; ancak bu genel internet demek zorunda değildir. Çağıran içinde çalışıyorsa özel ağ, VPN veya iç yük dengeleyici yeterlidir. Kendi eşleştirici ve çıkarıcı doğrulamamız kimlik doğrulama kapalı yalnızca loopback dinleyicisi kullandı; bu dışa açık uç nokta için örnek değildir. Takma ada güvenilen ağ dışından erişilebiliyorsa desteklenen doğrulamayı yapılandırın ve ağ katmanında da erişimi sınırlayın.

Önce entegrasyonu zararsız Görev Şablonuna yönlendirin, sonra verileri curl veya herhangi bir HTTP istemcisiyle kendiniz gönderin. Eşleşmeyen gövde gönderip görev oluşmadığını doğrulayın; sonra eşleşen gövdeyle tam bir görev başladığını doğrulayın. Görevin Details görünümünü açın: entegrasyonu kaynak olarak kaydeder, çıkarılan değerler çalıştırmaya görünür. Yerelde kullandığımız aynı sıra, dış servis bağımlı olmadan yanlış eşleştirici anahtarını yakalar.

Evet. REST API projeleri, depoları, envanterleri, kimlik bilgilerini, Değişken Gruplarını, Görev Şablonlarını ve diğer otomasyon kaynaklarını kapsar. Portal veya altyapı servisi bunları yapılandırabilir, görev başlatıp yürütme durumunu ve çıktıyı okuyabilir. Pro İş Akışı çalıştırmalarını ve onaylarını da API üzerinden sunar; CI/CD hattı tam çok adımlı işlem başlatabilir. Uç nokta parametreleri ve yanıt şemaları için OpenAPI başvurusunu kullanın.