Başlangıç (Kurulum)

FOCUSKARGO API’si, internet üzerinden oturum bilgisi tutmayan (stateless) Restful servis odaklı bir mimaride geliştirilmiştir. FOCUSKARGO 'nun sunduğu sunucu taraflı programlama diline uygun istemciler (client) ile çok kolay entegre olunabilir. Başlamak için aşağıdaki adımları izleyebilirsiniz.

- API sistemini kullanmak için FOCUSKARGO yönetiminden API_KEY talep etmeniz gerekmektedir. Tüm API servislerine erişim API_KEY üzerinden gerçekleştirilecektir.

- Tüm servislerin REQUEST ve RESPONSE parametreleri methodların ilgili sekmesinde açıklanmıştır.

Aşağıda API sistemini kullanabileceğiniz örnek kodlar sunulmuştur. İndirilebilir dosyadır.

  • Örnek Kod

Example Code

<?php

use \FOCUSKARGO\Libraries\restapi;

/* Api class dahil ediliyor.*/
include("src/libraries/restapi.php");

/* Api nesne türetiliyor.*/
$api = new restapi();

/* parametreler array olarak hazırlanmalı */
$prms = array(
    "alici" => array(
        "adsoyad" => "deneme test",
        "adres" => "adres test",
        "il_id" => 34,
        "ilce_id" => 441,
        "tel" => "507000000"
    ),
    "kargo" => array(
        "teslimat_tipi_id" => 1,
        "odeme_tipi_id" => 2,
        "odeme_sekli_id" => 3,
        "kargosu" => "focus-kargo",
        "adet" => 1,
        "desi" => 1.25,
        "tutar" => 158.90,
        "icerik" => "test icerik",
        "aciklama" => "test açıklama"
    ),
);

$response = $api->setApiKey('YOUR_API_KEY')
                ->setReturnType('json')
                ->setParams($prms)
                ->yeni_olustur()
                ->getResponse();

print $response;
Kargo Oluştur

Bu api ile yeni bir kargo oluşturabilirsiniz.

REQUEST
token
type : string
required : Zorunlu
aciklama : Token Bilgisi
adsoyad
type : string
required : Zorunlu
aciklama : Alıcı Ad Soyad / Ünvan Bilgisi
adres
type : string
required : Zorunlu
aciklama : Alıcı Adres Bilgisi
il_id
type : int
required : Zorunlu
aciklama : Alıcı il ID Bilgisi
ilce_id
type : int
required : Zorunlu
aciklama : Alıcı ilçe ID Bilgisi
tel
type : string
required : Zorunlu
aciklama : Alıcı Adres Bilgisi
teslimat_tipi_id
type : int
required : Zorunlu
aciklama : Kargo Teslimat Tipi ID Bilgisi
odeme_tipi_id
type : int
required : Zorunlu
aciklama : Kargo Ödeme Tipi ID Bilgisi
odeme_sekli_id
type : int
required : Zorunlu
aciklama : Kargo Ödeme Şekli ID Bilgisi
adet
type : int
required : Zorunlu
aciklama : Kargo Adet Bilgisi
desi
type : float
required : Zorunlu
aciklama : Kargo Desi Bilgisi (küsürat noktalı kullanım. örn: 1.7)
tutar
type : double
required : Zorunlu Değil
aciklama : Kargo Tutar Bilgisi (küsürat noktalı kullanım. örn: 100.75)
icerik
type : string
required : Zorunlu
aciklama : Kargo İçerik Bilgisi
aciklama
type : string
required : Zorunlu
aciklama : Kargo Açıklama Bilgisi
referans_barkod
type : string
required : Zorunlu
aciklama : Müşteri barkodu
referans_unvan
type : string
required : Zorunlu
aciklama : Müşteri ünvanı
referans_adres
type : string
required : Zorunlu
aciklama : Müşteri adresi
referans_telefon
type : string
required : Zorunlu
aciklama : Müşteri telefonu
referans_il
type : int
required : Zorunlu
aciklama : Müşteri ili
referans_ilce
type : int
required : Zorunlu
aciklama : Müşteri ilçesi
RESPONSE
status
type : boolean
aciklama : true veya false
message
type : string
aciklama : hata veya başarılı sonuç mesajı
data
type : json
aciklama :
barkod
type : string
aciklama : Barkod no bilgisi
POST /kargo/yeni_olustur

Example

Collapse All Expand All
{"auth":{"token":""},"data":{"alici":{"adsoyad":"","adres":"","il_id":"","ilce_id":"","tel":""},"kargo":{"teslimat_tipi_id":"","odeme_tipi_id":"","odeme_sekli_id":"","adet":"","desi":"","tutar":"","icerik":"","aciklama":"","referans_barkod":"","referans_unvan":"","referans_adres":"","referans_telefon":"","referans_il":"","referans_ilce":""}}}
Collapse All Expand All
{"status":"","message":"","data":{"barkod":""}}
Kargo Sorgula

Bu api ile sistemdeki kargonuzun durumunu sorgulayabilirsiniz.

REQUEST
token
type : string
required : Zorunlu
aciklama : Token Bilgisi
barkod
type : string
required : Zorunlu
aciklama : Kargo barkod bilgisi
RESPONSE
status
type : boolean
aciklama : true veya false
message
type : string
aciklama : hata veya başarılı sonuç mesajı
data
type : json
aciklama :
gonderici_adi
type : string
aciklama : Gönderici ad bilgisi
alici_adi
type : string
aciklama : Alıcı ad bilgisi
cikis_subesi
type : string
aciklama : Çıkış şube bilgisi
teslimat_subesi
type : string
aciklama : Teslimat şube bilgisi
gonderi_tarihi
type : string
aciklama : Gönderi tarih bilgisi
teslim_tarihi
type : string
aciklama : Teslim tarih bilgisi
teslim_alan
type : string
aciklama : Teslim alan bilgisi
gonderi_durum
type : json
aciklama : Gönderici durum bilgisi
odeme_sekli
type : string
aciklama : Ödeme şekli bilgisi
odeme_tipi
type : string
aciklama : Ödeme tipi bilgisi
kargo_desi
type : string
aciklama : Kargo desi bilgisi
kargo_adet
type : string
aciklama : Kargo adet bilgisi
tasima_ucreti
type : string
aciklama : Taşıma ücret bilgisi
tasiyici
type : string
aciklama : Taşıyıcı bilgisi
tasiyici_kod
type : string
aciklama : Taşıyıcı kod bilgisi
GET /kargo/kargo_sorgula

Example

Collapse All Expand All
{"auth":{"token":""},"data":{"barkod":""}}
Collapse All Expand All
{"status":"","message":"","data":{"gonderici_adi":"","alici_adi":"","cikis_subesi":"","teslimat_subesi":"","gonderi_tarihi":"","teslim_tarihi":"","teslim_alan":"","gonderi_durum":{"ID":2,"Name":"Durum ad"},"odeme_sekli":"","odeme_tipi":"","kargo_desi":1,"kargo_adet":1,"tasima_ucreti":10,"tasiyici":"focus-kargo","tasiyici_kod":"6841481041351"}}
Kargo Liste

Bu api ile sistemde bulunan kargolarınızın (durumlarına göre) / (tümü) listesini alabilirsiniz..

REQUEST
token
type : string
required : Zorunlu
aciklama : Token Bilgisi
kargo_durum_id
type : int
required : Zorunlu Değil
aciklama : Kargo Durum ID bilgisi (boş geçilirse tümü listelenir.)
gonderi_tarihi_baslangic
type : date
required : Zorunlu Değil
aciklama : Liste başlangıç tarihi bilgisi (tarih bilgileri boş olursa son 1 aylık data listelinir) örn: (2020-11-01)
gonderi_tarihi_bitis
type : date
required : Zorunlu Değil
aciklama : Liste başlangıç tarihi bilgisi (tarih bilgileri boş olursa son 1 aylık data listelinir) örn: (2020-11-30)
RESPONSE
status
type : boolean
aciklama : true veya false
message
type : string
aciklama : hata veya başarılı sonuç mesajı
data
type : json
aciklama :
gonderici_adi
type : string
aciklama : Gönderici ad bilgisi
alici_adi
type : string
aciklama : Alıcı ad bilgisi
cikis_subesi
type : string
aciklama : Çıkış şube bilgisi
teslimat_subesi
type : string
aciklama : Teslimat şube bilgisi
gonderi_tarihi
type : string
aciklama : Gönderi tarih bilgisi
teslim_tarihi
type : string
aciklama : Teslim tarih bilgisi
teslim_alan
type : string
aciklama : Teslim alan bilgisi
gonderi_durum
type : json
aciklama : Gönderici durum bilgisi
odeme_tipi
type : string
aciklama : Ödeme tipi bilgisi
kargo_desi
type : string
aciklama : Kargo desi bilgisi
kargo_adet
type : string
aciklama : Kargo adet bilgisi
GET /kargo/kargo_liste

Example

Collapse All Expand All
{"auth":{"token":""},"data":{"kargo_durum_id":"","gonderi_tarihi_baslangic":"","gonderi_tarihi_bitis":""}}
Collapse All Expand All
{"status":"","message":"","data":[{"gonderici_adi":"","alici_adi":"","cikis_subesi":"","teslimat_subesi":"","gonderi_tarihi":"","teslim_tarihi":"","teslim_alan":"","gonderi_durum":{"ID":2,"Name":"Durum ad"},"odeme_sekli":"","odeme_tipi":"","kargo_desi":1,"kargo_adet":1}]}
İl listesi

Bu api ile sistemde izin verilen illerin listesini alabilirsiniz..

REQUEST
token
type : string
required : Zorunlu
aciklama : Token Bilgisi
RESPONSE
status
type : boolean
aciklama : true veya false
message
type : string
aciklama : hata veya başarılı sonuç mesajı
data
type : json
aciklama :
ID
type : string
aciklama : İl ID bilgisi
Name
type : string
aciklama : İl ad bilgisi
GET /kargo/il_liste

Example

Collapse All Expand All
{"auth":{"token":""}}
Collapse All Expand All
{"status":"","message":"","data":[{"ID":1,"Name":"Adana"},{"ID":2,"Name":"Ad\u0131yaman"}]}
İlçe listesi

Bu api ile sistemde izin verilen ilçelerin ile göre listesini alabilirsiniz..

REQUEST
token
type : string
required : Zorunlu
aciklama : Token Bilgisi
il_id
type : int
required : Zorunlu
aciklama : İl ID bilgisi
RESPONSE
status
type : boolean
aciklama : true veya false
message
type : string
aciklama : hata veya başarılı sonuç mesajı
data
type : json
aciklama :
ID
type : string
aciklama : İlçe ID bilgisi
Name
type : string
aciklama : İlçe ad bilgisi
GET /kargo/ilce_liste

Example

Collapse All Expand All
{"auth":{"token":""},"data":{"il_id":""}}
Collapse All Expand All
{"status":"","message":"","data":[{"ID":1,"Name":"Pendik"},{"ID":2,"Name":"Kartal"}]}
Teslimat Tipi listesi

Bu api ile teslimat tipi listesini alabilirsiniz..

REQUEST
token
type : string
required : Zorunlu
aciklama : Token Bilgisi
RESPONSE
status
type : boolean
aciklama : true veya false
message
type : string
aciklama : hata veya başarılı sonuç mesajı
data
type : json
aciklama :
ID
type : string
aciklama : ID bilgisi
Name
type : string
aciklama : Ad bilgisi
GET /kargo/teslimat_tipi_liste

Example

Collapse All Expand All
{"auth":{"token":""}}
Collapse All Expand All
{"status":"","message":"","data":[{"ID":1,"Name":"\u015eube Teslim"},{"ID":2,"Name":"Adrese Teslim"}]}
Ödeme Tipi listesi

Bu api ile ödeme tipi listesini alabilirsiniz..

REQUEST
token
type : string
required : Zorunlu
aciklama : Token Bilgisi
RESPONSE
status
type : boolean
aciklama : true veya false
message
type : string
aciklama : hata veya başarılı sonuç mesajı
data
type : json
aciklama :
ID
type : string
aciklama : ID bilgisi
Name
type : string
aciklama : Ad bilgisi
GET /kargo/odeme_tipi_liste

Example

Collapse All Expand All
{"auth":{"token":""}}
Collapse All Expand All
{"status":"","message":"","data":[{"ID":1,"Name":"G\u00f6nderici \u00d6demeli"},{"ID":2,"Name":"Al\u0131c\u0131 \u00d6demeli"}]}
Ödeme Şekli listesi

Bu api ile ödeme şekli listesini alabilirsiniz..

REQUEST
token
type : string
required : Zorunlu
aciklama : Token Bilgisi
RESPONSE
status
type : boolean
aciklama : true veya false
message
type : string
aciklama : hata veya başarılı sonuç mesajı
data
type : json
aciklama :
ID
type : string
aciklama : ID bilgisi
Name
type : string
aciklama : Ad bilgisi
GET /kargo/odeme_sekli_liste

Example

Collapse All Expand All
{"auth":{"token":""}}
Collapse All Expand All
{"status":"","message":"","data":[{"ID":1,"Name":"Nakit \/ Kredi Kart\u0131"},{"ID":2,"Name":"Cari Hesap"}]}
Kargo Durum listesi

Bu api ile kargo durum listesini alabilirsiniz..

REQUEST
token
type : string
required : Zorunlu
aciklama : Token Bilgisi
RESPONSE
status
type : boolean
aciklama : true veya false
message
type : string
aciklama : hata veya başarılı sonuç mesajı
data
type : json
aciklama :
ID
type : string
aciklama : ID bilgisi
Name
type : string
aciklama : Ad bilgisi
GET /kargo/kargo_durum_liste

Example

Collapse All Expand All
{"auth":{"token":""}}
Collapse All Expand All
{"status":"","message":"","data":[{"ID":1,"Name":"G\u00f6ndericide"},{"ID":2,"Name":"Focus \u015eubede"}]}
Noisoft | Öncül Bilişim Teknolojileri Yazılım San. ve Tic. A.Ş. | 0216 60 60 900 | www.noisoft.com.tr