BenimPOS API: açarlar, test hesabı və sənədlər
API açarlarının alınması, ümumi test hesabı, tərtibatçı sənədləri (benimpos.com/developers) və tez-tez verilən suallar.
BenimPOS API hesabınızdakı məlumatlara öz proqramınızdan daxil olmağa imkan verir: e-ticarət saytınıza məhsul, stok və qiymət ötürə, saytdakı sifarişləri BenimPOS-a satış kimi yaza, mühasibat və ya hesabat sisteminizə satış, müştəri, təchizatçı, alış fakturası və gəlir-xərc məlumatlarını çəkə bilərsiniz.
API modulu illik 1.800,00 TL ödənişlidir və İnteqrasiyalar › API inteqrasiyası tabından alınır. Ayrıca test mühiti yoxdur; sınaqlar üçün ümumi test hesabından istifadə edə bilərsiniz (aşağıda). API ilə ÖKC-yə (Türkiyədəki fiskal kassa aparatı) qəbz göndərmək olmur; fiskal kassa inteqrasiyaları yalnız BenimPOS tətbiqlərinin içində işləyir.
API sənədləri
Bütün servislər, parametrlər, nümunə sorğu və cavablar, xəta kodları və istifadə limitləri tərtibatçı səhifəmizdədir: benimpos.com/developers. Səhifə türk və ingilis dillərindədir. Hər əməliyyatı səhifədəki Try düyməsi ilə brauzerdən işə salıb cavabını görə bilərsiniz.
API-yə əlavə olunan servislər və dəyişikliklər Yeniliklər səhifəsində elan edilir. Köhnə PDF sənəd artıq yenilənmir; sahə adları və davranış üçün tərtibatçı səhifəsini əsas götürün.
API açarlarının alınması
Modulu satın alın
Veb paneldə sol menyunun ən aşağısındakı İnteqrasiyalar səhifəsində API inteqrasiyası tabını açın və kartdakı Satın al ilə alışı tamamlayın.
Məlumatlarınızı açın
Satın aldıqdan sonra səhifənin yuxarısındakı cədvəldə API inteqrasiyası sətri görünür. Sətirdəki qələm işarəsinə basın; API inteqrasiya məlumatlarınız pəncərəsi açılır.
Dəyərləri kopyalayın
Pəncərədə üç dəyər var: Branch ID (mağaza kodu), Api Key və Secret Key. Onları kopyala işarəsi ilə götürüb proqramınızın ayarlarına daxil edin.
Açarlar hesabınıza tam giriş verir: onları kod repozitoriyasına, brauzerdə işləyən koda (JavaScript) və ya mesajlara yazmayın; yalnız server tərəfində saxlayın. Açarın başqasının əlinə keçdiyini düşünürsünüzsə, pəncərədəki yeniləmə işarəsi ilə yeni açar yaradın; köhnə açar dərhal etibarsız olur, proqramınızdakı dəyəri yeniləməyi unutmayın.
- Hər filial ayrıca hesabdır və onun öz Branch ID-si və açarları var. Məlumatlarına daxil olacağınız hər filial hesabında API modulu ayrıca aktivləşdirilir.
- Modulun müddəti bitəndə servislər daha 3 gün işləyir, sonra sorğular rədd edilir. Müddəti İnteqrasiyalar səhifəsindəki Müddəti uzat ilə yeniləyin.
Test hesabı
Sorğular hesabınızın real məlumatlarını oxuyur və dəyişir. İnteqrasiyanı hazırlayarkən öz məlumatlarınıza toxunmamaq üçün ümumi test hesabından istifadə edin. Giriş məlumatları API sənədlərindəki Test hesabı bölməsindədir: daxil olub İnteqrasiyalar › API inteqrasiyası sətrindən açarları götürün, proqramınızda və ya sənədlərdəki Try ekranında istifadə edin.
Test hesabı hamıya açıqdır; içindəki məlumatları hər kəs görə və dəyişə bilər. Real müştəri və ya satış məlumatı daxil etməyin.
Qısa xülasə
| Mövzu | Dəyər |
|---|---|
| Ünvan | https://dev.benimpos.com/api/<servis> (məs. /api/products) |
| Metod | POST, JSON gövdə, ən çox 2 MB |
| Autentifikasiya | HTTP başlıqları: Branch-ID, Api-Key, Secret-Key |
| Əməliyyatın seçilməsi | Gövdədəki processType sahəsi (məs. "list", "create") |
| Servislər | Məhsullar və alış fakturaları (products), müştərilər (customers), satışlar (sales), təchizatçılar (firms), kateqoriyalar (categories), ödəniş növləri (paymentTypes), gəlir-xərc (incomeExpenses) |
Tez-tez verilən suallar
API ilə alış fakturası yarada bilərəmmi?
Bəli. Məhsullar servisindəki createPurchaseInvoice əməliyyatı fakturanı qeyd edir, məhsulları stoka mədaxil edir və nisyə fakturada məbləği təchizatçının hesabına yazır. Eyni faktura ikinci dəfə göndərilərsə, yeni qeyd yaranmır.
Məhsula API ilə qrup (kateqoriya) təyin edə bilərəmmi?
Xeyr, məhsul əlavə edərkən və yeniləyərkən qrup sahəsi yoxdur. Qrupları categories servisi ilə oxuya, məhsullara qrupu veb paneldən və ya Excel ilə təyin edə bilərsiniz.
Eyni sifariş iki dəfə satış kimi yazılmasın deyə nə etməliyəm?
Satış yaradarkən externalRef sahəsinə öz sifariş nömrənizi yazın. Eyni nömrə ilə gələn ikinci sorğu yeni satış açmır, ilk satışın kodunu qaytarır.
Masaüstü proqramda etdiyim satış API-də nə vaxt görünür?
Masaüstü proqram məlumatları vebə göndərdikdən (sinxronizasiya) sonra. Masaüstü proqramda ana səhifədəki Məlumat inteqrasiyası kartından sinxronizasiyanı dərhal başlada bilərsiniz. Veb və mobil tətbiqdəki satışlar dərhal görünür.
Texniki dəstəyi necə ala bilərəm?
Sualınızı [email protected] ünvanına yazın. Sorğunun vaxtını, ünvanını, gövdəsini (açarlar istisna olmaqla), HTTP status kodunu, cavab mesajını və varsa X-BP- ilə başlayan cavab başlıqlarını əlavə edin. API açarlarınızı paylaşmayın.