İş 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:
| Anahtar | Nereden | Ne 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.
- Çalışma alanını açma —
create-teamile ad, saat dilimi ve açılacak modülleri gönderirsiniz. Yanıttakislug,gateway_url,api_keyveapi_secret'i saklayın; çalışma alanına bundan sonra bunlarla ulaşırsınız. - Ödeme hesabı ekleme — Siparişin ödenebilmesi için çalışma alanında ödeme hesabı olmalıdır.
retrieve-providerseklenebilen sağlayıcıları ve her birinin istediği alanları döner;create-payment-providerhesabı ekler. - Webhook adresi —
create-webhook-endpointile ç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. - Ödeme sayfası — İsterseniz
create-logoile logo yükler,update-checkout-designile ödeme sayfasının görünümünü değiştirirsiniz. - Kullanım — Çalışma alanının anahtarıyla
create-order,create-bank-accountgibi 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
401dö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.
- PHP
- Node.js
- Python
- Java
- cURL
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ı
import { PartnerClient } from '@odemehub/node-sdk';
const partner = new PartnerClient({
baseUrl: 'https://sandbox.odemehub.com',
apiKey: process.env.ODEMEHUB_PARTNER_API_KEY!,
apiSecret: process.env.ODEMEHUB_PARTNER_API_SECRET!,
});
const client = partner.teamClient(team); // team: create-team ya da retrieve-teams yanıtındaki çalışma alanı
import os
from odemehub import PartnerClient, PartnerOptions
partner = PartnerClient(PartnerOptions(
base_url="https://sandbox.odemehub.com",
api_key=os.environ["ODEMEHUB_PARTNER_API_KEY"],
api_secret=os.environ["ODEMEHUB_PARTNER_API_SECRET"],
))
client = partner.team_client(team) # team: create-team ya da retrieve-teams yanıtındaki çalışma alanı
import com.odemehub.Client;
import com.odemehub.PartnerClient;
import com.odemehub.PartnerOptions;
PartnerClient partner = new PartnerClient(PartnerOptions.builder()
.baseUrl("https://sandbox.odemehub.com")
.apiKey(System.getenv("ODEMEHUB_PARTNER_API_KEY"))
.apiSecret(System.getenv("ODEMEHUB_PARTNER_API_SECRET"))
.build());
Client client = partner.teamClient(team); // team: create-team ya da retrieve-teams yanıtındaki çalışma alanı
SDK kullanmadan her isteği iş ortağının gizli anahtarıyla kendiniz imzalarsınız. cURL örnekleri şu değişkenleri kullanır:
export ODEMEHUB_PARTNER_API_KEY="..."
export ODEMEHUB_PARTNER_API_SECRET="..."
Açılan çalışma alanları
- Çalışma alanı
slugile 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ınslug'ı404alı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-team422dö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.
| Konu | Uçlar |
|---|---|
| Ödeme hesapları | retrieve-providers, create-payment-provider, retrieve-payment-providers, update-payment-provider, delete-payment-provider |
| Webhook adresleri | create-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.
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.