BenimPOS API: anahtarlar, test hesabı ve doküman
API anahtarlarını alma, ortak test hesabı, geliştirici dokümanı (benimpos.com/developers) ve sık sorulan sorular.
BenimPOS API'si, hesabınızdaki verilere kendi yazılımınızdan erişmenizi sağlar: e-ticaret sitenize ürün, stok ve fiyat aktarabilir, sitedeki siparişleri BenimPOS'a satış olarak yazabilir, muhasebe ya da raporlama sisteminize satış, müşteri, tedarikçi, alış faturası ve gelir-gider verilerini çekebilirsiniz.
API modülü yıllık 1.800,00 TL ücretlidir ve Entegrasyonlar › API Entegrasyonu sekmesinden satın alınır. Ayrı bir test ortamı yoktur; denemeler için ortak test hesabını kullanabilirsiniz (aşağıda). API ile yazarkasaya fiş gönderilemez; yazarkasa entegrasyonları yalnız BenimPOS uygulamaları içinde çalışır.
API dokümanı
Bütün servisler, parametreler, örnek istek ve yanıtlar, hata kodları ve kullanım limitleri geliştirici sayfamızdadır: benimpos.com/developers. Sayfa Türkçe ve İngilizcedir. Her işlemi sayfadaki Dene düğmesiyle tarayıcıdan çalıştırıp yanıtını görebilirsiniz.
API'ye eklenen servisler ve değişiklikler Yenilikler sayfasında duyurulur. Eski PDF doküman artık güncellenmiyor; alan adları ve davranış için geliştirici sayfasını esas alın.
API anahtarlarını alma
Modülü satın alın
Web panelinde sol menünün en altındaki Entegrasyonlar sayfasında API Entegrasyonu sekmesini açın ve karttaki Satın Al ile satın almayı tamamlayın.
Bilgilerinizi açın
Satın almadan sonra sayfanın üstündeki tabloda API Entegrasyonu satırı görünür. Satırdaki kalem simgesine basın; API Entegrasyon Bilgileriniz penceresi açılır.
Değerleri kopyalayın
Pencerede üç değer vardır: Branch ID (mağaza kodu), Api Key ve Secret Key. Kopyala simgesiyle alıp uygulamanızın ayarlarına girin.
Anahtarlar hesabınıza tam erişim sağlar: kod deposuna, tarayıcıda çalışan koda (JavaScript) ya da mesajlara yazmayın; yalnız sunucu tarafında saklayın. Anahtarın ele geçtiğini düşünüyorsanız penceredeki yenile simgesiyle yeni anahtar üretin; eski anahtar hemen geçersiz olur, uygulamanızdaki değeri güncellemeyi unutmayın.
- Her şube ayrı bir hesaptır ve kendi Branch ID'si ile anahtarlarına sahiptir. Verisine erişeceğiniz her şube hesabında API modülü ayrıca etkinleştirilir.
- Modülün süresi dolduğunda servisler 3 gün daha çalışır, sonra istekler reddedilir. Süreyi Entegrasyonlar sayfasındaki Süre Uzat ile yenileyin.
Test hesabı
İstekler hesabınızın gerçek verisini okur ve değiştirir. Entegrasyonu geliştirirken kendi verilerinize dokunmamak için ortak test hesabını kullanın. Giriş bilgileri API dokümanındaki Test hesabı bölümündedir: giriş yapıp Entegrasyonlar › API Entegrasyonu satırından anahtarları alın, uygulamanızda ya da dokümandaki Dene ekranında kullanın.
Test hesabı herkese açıktır; içindeki verileri herkes görebilir ve değiştirebilir. Gerçek müşteri ya da satış bilgisi girmeyin.
Kısa özet
| Konu | Değer |
|---|---|
| Adres | https://dev.benimpos.com/api/<servis> (ör. /api/products) |
| Yöntem | POST, JSON gövde, en fazla 2 MB |
| Kimlik doğrulama | HTTP başlıkları: Branch-ID, Api-Key, Secret-Key |
| İşlem seçimi | Gövdedeki processType alanı (ör. "list", "create") |
| Servisler | Ürünler ve alış faturaları (products), müşteriler (customers), satışlar (sales), tedarikçiler (firms), kategoriler (categories), ödeme tipleri (paymentTypes), gelir-gider (incomeExpenses) |
Sık sorulan sorular
API ile alış faturası oluşturabilir miyim?
Evet. Ürünler servisindeki createPurchaseInvoice işlemi faturayı kaydeder, ürünleri stoğa sokar ve açık hesap faturada tutarı tedarikçinin hesabına yazar. Aynı fatura ikinci kez gönderilirse yeni kayıt oluşmaz.
Ürüne API ile grup (kategori) atayabilir miyim?
Hayır, ürün ekleme ve güncellemede grup alanı yoktur. Grupları categories servisiyle okuyabilir, ürünlere grubu web panelinden ya da Excel ile atayabilirsiniz.
Aynı sipariş iki kez satış olarak yazılmasın diye ne yapmalıyım?
Satış oluştururken externalRef alanına kendi sipariş numaranızı yazın. Aynı numarayla gelen ikinci istek yeni satış açmaz, ilk satışın kodunu döner.
Masaüstünde yaptığım satış API'de ne zaman görünür?
Masaüstü uygulaması verileri web'e gönderdikten (eşitleme) sonra. Masaüstünde ana sayfadaki Veri entegrasyonu kartından eşitlemeyi hemen başlatabilirsiniz. Web ve mobil uygulamadaki satışlar anında görünür.
Teknik destek nasıl alırım?
Sorunuzu [email protected] adresine yazın. İsteğin saatini, adresini, gövdesini (anahtarlar hariç), HTTP durum kodunu, yanıt mesajını ve varsa X-BP- ile başlayan yanıt başlıklarını ekleyin. API anahtarlarınızı paylaşmayın.