Skip to main content
AgencyHandy API, herhangi bir harici sistemden veya komut dosyasından lead oluşturmayı, müşteri yönetimini, sipariş güncellemelerini ve daha fazlasını otomatikleştirmenizi sağlar. Her istek, çalışma alanı ayarlarınızdan oluşturduğunuz bir API anahtarıyla doğrulanır. Bu rehber, kimlik bilgilerinizi edinme ve ilk API çağrınızı yapma adımlarını anlatır.
API anahtarı oluşturabilmek için AgencyHandy çalışma alanınızda SuperAdmin veya Admin olmanız gerekir.

​
Temel URL

Tüm API istekleri şu adrese yapılır:
API belgelerindeki tüm örnek isteklerde {{URL}} ifadesini bu temel URL ile değiştirin.

​
1. Adım: API anahtarı oluşturun

1

Çalışma Alanı Yapılandırması'nı açın

Çalışma alanı ayarlarınıza şu adresten gidin:
Bu, Çalışma Alanı Yapılandırması içindeki API Anahtarı sekmesini açar.
2

API anahtarınızı oluşturun ve kopyalayın

Oluştur (veya zaten bir anahtar mevcutsa Yeniden Oluştur) düğmesine tıklayın. API anahtarını kopyalayın ve güvenli bir yerde saklayın — bir parola gibi davranın. AgencyHandy sayfadan ayrıldıktan sonra anahtarı tekrar göstermez.
API anahtarını yeniden oluşturmak, önceki anahtarı hemen geçersiz kılar. Eski anahtarı kullanan mevcut entegrasyonlar, yeni anahtarla güncellenene kadar çalışmayı durduracaktır.

​
2. Adım: Şirket Kimliğinizi alın

Çoğu API uç noktası, isteğin hangi çalışma alanını hedeflediğini belirten bir companyid başlığı gerektirir. Şirket Kimliğinizi almak için aşağıdaki uç noktayı kullanın.

​
Uç nokta

​
Başlıklar

​
Örnek istek

cURL

​
Örnek yanıt

1

Şirket Kimliğinizi bulun

Yanıtta companies dizisinin içindeki _id alanını bulun. Bu sizin Şirket Kimliğinizdir.
2

Şirket Kimliğini saklayın

Şirket Kimliğini sonraki tüm API isteklerinde kullanmak üzere kaydedin. companyid başlığı olarak ileteceksiniz:

​
Kimlik doğrulama özeti

Her kimlik doğrulamalı API isteği en az şunları gerektirir:
API anahtarınız ve Şirket Kimliğiniz elinizde olduğunda, AgencyHandy API’sinin geri kalanını kullanmaya hazırsınız. Aşağıdaki uç nokta rehberlerinden birine devam edin.