Laravel KolayBi API

Bu paket, KolayBi API servisleri ile Laravel projeniz arasında hızlı ve güvenli bir köprü kurar. Otomatik bearer alarak arka planda otomatik yöneterek geliştirme sürecinizi hızlandırır.

Neden ihtiyaç var?

KolayBi API entegrasyonu yaparken tekrar eden kimlik doğrulama işlemleri, dinamik token yönetimi ve karmaşık JSON yapılarıyla uğraşmak yerine; Laravel standartlarına uygun Facade yapısını kullanan, her Resource için hazır validasyonları olan sade bir çözüme ihtiyaç duyulmaktadır.

Başlarken

Paketi kullanabilmek için KolayBi üzerinden API Key ve Channel ID bilgilerine sahip olmanız gerekmektedir.

Kurulum

composer require theposeidonas/laravel-kolaybi-api

Config dosyasını yayınlamak için:

php artisan vendor:publish --tag=kolaybi-config --force

Konfigürasyon

.env dosyanıza aşağıdaki bilgileri ekleyin:

KOLAYBI_API_KEY="your-api-key"
KOLAYBI_CHANNEL_ID="your-channel-id"
KOLAYBI_SANDBOX=true
KOLAYBI_BASE_URL="https://ofis-sandbox-api.kolaybi.com"

Kullanım

Kullanacağınız Controller içerisine paketi dahil edin:

use Theposeidonas\Kolaybi\Facades\Kolaybi;

Sınıflar (Resources)

Tüm modüllere Facade üzerinden erişebilirsiniz:

Kolaybi::bank(); // Kasa ve Banka Hesapları
Kolaybi::company(); // Şirket Yönetimi
Kolaybi::associate(); // Cari (Müşteri ve Tedarikçi) Yönetimi
Kolaybi::invoice(); // Satış ve Alış Faturası İşlemleri
Kolaybi::product(); // Ürün, Hizmet ve Stok Yönetimi
Kolaybi::order(); // Sipariş Yönetimi
Kolaybi::proforma(); // Proforma Fatura İşlemleri
Kolaybi::tag(); // Etiket Yönetimi
Kolaybi::user(); // Kullanıcı ve Yetki Yönetimi

Yanıt Yapısı

Tüm istekler KolaybiResponse sınıfı döner. Başarı kontrolü ve veriye erişim şu şekildedir:

$response = Kolaybi::bank()->list();

if ($response->isSuccess()) {
$data = $response->getData();
$status = $response->getStatus();
}

Tüm Fonksiyonlar ve Parametreleri

Aşağıda paket içerisindeki kullanabileceğiniz tüm fonksiyonlar bulunuyor. Parametre detayları için döküman linklerini inceleyebilirsiniz. Eğer tek bir parametre bekleniyorsa, direk bu parametreyi, eğer birden fazla parametre bekleniyorsa da array şeklinde göndermelisiniz.

Kasa ve Banka (BankResource)

Kolaybi::bank()->list($query); // Kasa ve banka hesaplarını listeleme -> https://developer.kolaybi.com/docs/vaults/list/ 
Kolaybi::bank()->find($vaultId); // Belirli bir kasa/banka detayını görüntüleme -> https://developer.kolaybi.com/docs/vaults/detail 
Kolaybi::bank()->transactions($vaultId); // Kasa/banka hesap hareketlerini listeleme -> https://developer.kolaybi.com/docs/vaults/transactions] 

Şirket (CompanyResource)

Kolaybi::company()->list(); // Yetkili olunan şirketleri listeleme -> https://developer.kolaybi.com/docs/companies/list/

Cari Hesap (AssociatesResource)

Kolaybi::associate()->list(); // Cari hesapları (müşteri ve tedarikçi) listeleme -> https://developer.kolaybi.com/docs/associates/list/ 
Kolaybi::associate()->create($data); // Yeni cari hesap (müşteri/tedarikçi) oluşturma -> https://developer.kolaybi.com/docs/associates/create/ 
Kolaybi::associate()->addressCreate($data); // Mevcut bir cari hesaba yeni adres ekleme -> https://developer.kolaybi.com/docs/associates/addresses/ 
Kolaybi::associate()->transactions($associateId); // Cari hesaba ait tüm hareketleri listeleme -> https://developer.kolaybi.com/docs/associates/transactions/ 
Kolaybi::associate()->payment($id, $data); // Cari hesaptan tahsilat yapma (Ödeme Girişi) -> https://developer.kolaybi.com/docs/associates/payment/ 
Kolaybi::associate()->proceed($id, $data); // Cari hesaba ödeme yapma (Ödeme Çıkışı) -> https://developer.kolaybi.com/docs/associates/proceed/ 

Fatura (InvoiceResource)

Kolaybi::invoice()->list($query); // Satış ve alış faturalarını listeleme -> https://developer.kolaybi.com/docs/invoices/list/ 
Kolaybi::invoice()->create($data); // Yeni fatura (satış/alış) oluşturma -> https://developer.kolaybi.com/docs/invoices/create/ 
Kolaybi::invoice()->find($documentId); // Belirli bir faturanın detaylarını görüntüleme -> https://developer.kolaybi.com/docs/invoices/detail/ 
Kolaybi::invoice()->formalize($documentId); // E-Fatura Gönderimi (Taslak Faturayı Resmileştirme) -> https://developer.kolaybi.com/docs/invoices/e-document/ 
Kolaybi::invoice()->collect($data); // Fatura Tahsilat -> https://developer.kolaybi.com/docs/invoices/proceed/ 
Kolaybi::invoice()->delete($documentId); // Mevcut bir faturayı silme -> https://developer.kolaybi.com/docs/invoices/delete/ 
Kolaybi::invoice()->deleteCollection($documentId); // Fatura üzerindeki tahsilat/ödeme kaydını silme -> https://developer.kolaybi.com/docs/invoices/proceed-delete/ 
Kolaybi::invoice()->cancelEDocument($documentId); // Resmileşmiş bir e-belgeyi iptal etme -> https://developer.kolaybi.com/docs/invoices/e-document-cancel/ 
Kolaybi::invoice()->viewEDocument($uuid); // E-Belgenin görüntüsünü (HTML/PDF) alma -> https://developer.kolaybi.com/docs/invoices/e-document-view/ 
Kolaybi::invoice()->resendEDocument($documentId); // E-Belgeyi alıcıya tekrar e-posta ile gönderme -> https://developer.kolaybi.com/docs/invoices/resend/ 
Kolaybi::invoice()->listEInvoices($query); // Gelen kutusuna düşen e-faturaları listeleme -> https://developer.kolaybi.com/docs/e-documents/list 

Sipariş (OrderResource)

Kolaybi::order()->create($data); // Yeni sipariş oluşturma -> https://developer.kolaybi.com/docs/orders/create/ 
Kolaybi::order()->find($documentId); // Belirli bir siparişin detaylarını görüntüleme -> https://developer.kolaybi.com/docs/orders/detail/ 

Ürün ve Stok (ProductResource)

Kolaybi::product()->list($query); // Ürün ve hizmetleri listeleme -> https://developer.kolaybi.com/docs/products/list/ 
Kolaybi::product()->create($data); // Yeni ürün veya hizmet oluşturma -> https://developer.kolaybi.com/docs/products/create/ 
Kolaybi::product()->find($productId); // Belirli bir ürünün detaylarını görüntüleme -> https://developer.kolaybi.com/docs/products/detail/ 
Kolaybi::product()->update($productId, $data); // Mevcut ürün bilgilerini güncelleme -> https://developer.kolaybi.com/docs/products/update/ 
Kolaybi::product()->stock($data); // Ürün için stok girişi veya çıkışı yapma (Stok Hareketleri) -> https://developer.kolaybi.com/docs/products/stock/ 

Proforma Fatura (ProformaResource)

Kolaybi::proforma()->create($data); // Yeni proforma fatura oluşturma -> https://developer.kolaybi.com/docs/proformas/create/ 
Kolaybi::proforma()->find($documentId); // Belirli bir proforma faturanın detaylarını görüntüleme -> https://developer.kolaybi.com/docs/proformas/detail/ 

Etiket (TagResource)

Kolaybi::tag()->list($query); // Etiketleri listeleme -> https://developer.kolaybi.com/docs/tags/list/ 
Kolaybi::tag()->find($tagId); // Belirli bir etiketin detaylarını görüntüleme -> https://developer.kolaybi.com/docs/tags/detail 

Kullanıcı (UserResource)

Kolaybi::user()->list(); // Şirketteki kullanıcıları listeleme -> https://developer.kolaybi.com/docs/users/list/ 

TODO

• Temel Resource yapıları tamamlandı.
• Unit testler eklendi.

Lisanslama

MIT Lisansı ile dağıtılmaktadır. Detaylar için LICENSE dosyasına bakabilirsiniz.

İletişim

Baran Arda - @theposeidonas - baran@webremium.com

Proje Linki: https://github.com/theposeidonas/laravel-kolaybi-api