Ana içeriğe geç

İş Ortakları

İş ortağı, ödemehub'ı kendi uygulamasının arkasında kullanan ve kendi müşterileri için çalışma alanlarını API'den açıp yöneten kullanıcıdır. Bir kullanıcıyı iş ortağı ödemehub yapar; iş ortağı olduktan sonra iki tür anahtarla çalışırsınız:

AnahtarNeredenNe için
İş ortağı anahtarıPanelde Ayarlar → İş OrtaklığıÇalışma alanlarının üstündeki işler: açma (create-team), sorgulama (retrieve-teams), modül değiştirme (update-team-modules), silme (delete-team).
Çalışma alanının anahtarıcreate-team / retrieve-teams yanıtıÇalışma alanının içindeki her iş: ödeme hesabı, webhook adresi, ad, ödeme sayfası tasarımı, sipariş, ödeme linki, banka hareketleri ve diğer bütün gateway uçları.

Çalışma alanının içindeki bir iş için iş ortağı anahtarı kullanılmaz, team_id gibi bir alan da gönderilmez: çalışma alanı gateway adresinde (/api/{team}/gateway/...) ve anahtarında bellidir.

  1. Çalışma alanını açma — create-team ile ad, saat dilimi ve açılacak modülleri gönderirsiniz. Yanıttaki slug, gateway_url, api_key ve api_secret'i saklayın; çalışma alanına bundan sonra bunlarla ulaşırsınız.
  2. Ödeme hesabı ekleme — Siparişin ödenebilmesi için çalışma alanında ödeme hesabı olmalıdır. retrieve-providers eklenebilen sağlayıcıları ve her birinin istediği alanları döner; create-payment-provider hesabı ekler.
  3. Webhook adresi — create-webhook-endpoint ile çalışma alanının olaylarının gönderileceği adresi eklersiniz. Webhook'lar çalışma alanının gizli anahtarıyla imzalanır.
  4. Ödeme sayfası — İsterseniz create-logo ile logo yükler, update-checkout-design ile ödeme sayfasının görünümünü değiştirirsiniz.
  5. Kullanım — Çalışma alanının anahtarıyla create-order, create-bank-account gibi bütün gateway uçlarını kullanırsınız.

İş ortağı anahtarı​

Anahtar, panelde Ayarlar → İş Ortaklığı sayfasındadır; sayfa şifre onayı ister ve yalnızca iş ortaklarına görünür. Aynı sayfadan anahtar yenilenir; yenilenen anahtar eskisini hemen geçersiz kılar. Bu sayfa ayrıca açtığınız çalışma alanı sayısını ve ödemehub'ın size tanımladığı sınırı gösterir.

İş ortağı uçları /api/partner/ altındadır:

POST /api/partner/{endpoint}

İmza, çalışma alanı uçlarıyla aynı yöntemle alınır (Kimlik Doğrulama ve İmza); yalnızca anahtar ve gizli anahtar iş ortağınındır. path /api/partner/... yoludur. Yanıtlar da iş ortağının gizli anahtarıyla imzalanır.

  • Anahtar geçersizse ya da bir çalışma alanının anahtarı gönderilirse 401 döner: Geçersiz API anahtarı.
  • İş ortağı uçlarına iş ortağı başına dakikada en fazla 60 istek kabul edilir; aşılırsa 429: İstek sınırı aşıldı: iş ortağı uçlarına dakikada en fazla 60 istek kabul edilir. Lütfen bir dakika sonra yeniden deneyin.
  • İş ortaklığı kaldırılırsa anahtar çalışmaz; açılmış çalışma alanları ve onların anahtarları olduğu gibi kalır.

SDK'larda (1.0.8 ve sonrası) iş ortağı uçları PartnerClient ile çağrılır. PartnerClient çalışma alanı almaz; baseUrl ve iş ortağının anahtarlarıyla kurulur, istekleri /api/partner/... altına imzalayarak gönderir ve yanıtları iş ortağının gizli anahtarıyla doğrular. teamClient / team_client, açılan bir çalışma alanı için o çalışma alanının anahtarlarıyla istemciyi kurar. İş ortağı uç sayfalarındaki $partner / partner nesnesi budur; örnekler anahtarları ODEMEHUB_PARTNER_API_KEY ve ODEMEHUB_PARTNER_API_SECRET ortam değişkenlerinden okur.

use Gurmehub\Odemehub\PartnerClient;
use Gurmehub\Odemehub\PartnerOptions;

$partner = new PartnerClient(new PartnerOptions(
baseUrl: 'https://sandbox.odemehub.com',
apiKey: getenv('ODEMEHUB_PARTNER_API_KEY'),
apiSecret: getenv('ODEMEHUB_PARTNER_API_SECRET'),
));

$client = $partner->teamClient($team); // $team: create-team ya da retrieve-teams yanıtındaki çalışma alanı

Açılan çalışma alanları​

  • Çalışma alanı slug ile anılır: gateway adresindeki on haneli numara. İş ortağı yalnızca kendi açtığı çalışma alanlarına ulaşır; başka bir çalışma alanının slug'ı 404 alır. İş ortağı olmadan önce açtığınız çalışma alanları da bu uçlarla yönetilmez.
  • Açabileceğiniz çalışma alanı sayısını ödemehub belirler. Sınıra ulaşınca create-team 422 döner: İş ortaklığınızla en fazla {sınır} çalışma alanı açabilirsiniz. Silinen çalışma alanı sınırdan düşer.
  • Panelden açtığınız çalışma alanları da iş ortağı çalışma alanıdır ve aynı sınıra sayılır.
  • Açılan çalışma alanının sahibi sizsiniz; panelde de görünür. API'den açılan çalışma alanı paneldeki geçerli çalışma alanınızı değiştirmez.
  • Yeni çalışma alanı test modunda açılır (is_test: true). Mod API'den değiştirilmez, panelden değiştirilir: Ortamlar ve Adresler.

Modüller​

İş ortağı şu modülleri açar ve kapatır: api, orders, subscription, payment_links, saved_cards, bank_transactions. custom_domain ve shopify_pos'u yalnızca ödemehub açar; bunlar gönderilirse 422 döner: Bu modülü iş ortağı açamaz. Çalışma alanında açıksa olduğu gibi kalırlar.

Bir modül, ona bağlı bir şey sürerken kapatılamaz (örneğin süren abonelik varken Abonelikler); update-team-modules bu durumda 422 döner.

Sandbox'ta bütün modüller her zaman açıktır: create-team gönderilen modülleri dikkate almaz, update-team-modules 403 döner.

Yalnızca iş ortağı çalışma alanlarına açık uçlar​

Aşağıdaki gateway uçları çalışma alanının kendi anahtarıyla çağrılır ve yalnızca bir iş ortağının açtığı çalışma alanlarında çalışır. Diğer çalışma alanları 403 alır: Bu uç yalnızca iş ortağı çalışma alanlarına açıktır.

KonuUçlar
Ödeme hesaplarıretrieve-providers, create-payment-provider, retrieve-payment-providers, update-payment-provider, delete-payment-provider
Webhook adreslericreate-webhook-endpoint, retrieve-webhook-endpoints, update-webhook-endpoint, delete-webhook-endpoint
Çalışma alanıupdate-team
Ödeme sayfasıretrieve-checkout-design, update-checkout-design, create-logo

Bu uçlar herhangi bir modül istemez. Ödeme hesabının ayarları (sağlayıcı anahtarları) hiçbir yanıtta dönmez; bu bilgilerin saklanması sizin uygulamanızın sorumluluğundadır.

not

SDK'larda (1.0.8 ve sonrası) bu uçlar çalışma alanının istemcisindedir ($client / client); iş ortağı bu istemciyi teamClient / team_client ile kurar. Örnekler her uç sayfasının SDK örnekleri bölümündedir.