Bu belge, aşağıdaki eylemler için tüm API yöntemlerini açıklar:

• nesnelerin listelerini alma (liste yöntemi)
• liste filtreleme (filtre verileriyle liste yöntemi)
• bir nesne hakkında ayrıntılı bilgi alma (gösterme yöntemi)
• nesne ekleme formu için veri alma (yöntem ekleme)
• verileri yeni bir nesne olarak kaydetme (depolama yöntemi)
• nesne güncelleme formu için veri alma (düzenleme yöntemi)
• güncellenen nesnenin verilerini kaydetme (güncelleme yöntemi)

API yalnızca sınırlı bir IP adresi listesinden (örneğin, bir müşterinin hesap sitesinden veya bir arka ofis sitesinden) gelen istekleri kabul eder.

İzin verilenler listesinde olmayan bir IP adresinden API'ye yapılan herhangi bir istek reddedilecektir.

Bu, API'ye yapılan DDoS saldırılarını, istekleri tahrif etme girişimlerini ve bilgisayar korsanı deneylerini önlemek için yapılır.

Kullanıcılar her zaman platformun genel sitesine (müşterinin ofisi veya arka ofisi) erişir ve bu site, platformun API'sinden gerekli verileri ister. Sitenin IP adresi sabit olduğu için izin verilenler listesinde olacaktır.

Tüm API istekleri, aşağıdaki HTTP yöntemleri kullanılarak yapılır:

• GET listelemek, göstermek, eklemek ve düzenlemek için
• POST mağaza için
• PUT güncelleme için
• DELETE silmek için

API'nin her bölümü, ilgili verileri elde etmek için bir istekte bulunulan bir URL içerir.

HTTP istek yöntemi, her URL'nin önünde belirtilir.

Her API isteği her zaman 4 değişken içermelidir:

1. data (API için veri dizili json dizesi)
2. user (geçerli kullanıcı hakkında bir dizi veri içeren json dizesi)
3. time (UTC saat diliminde geçerli saat)
4. hash (API'ye yapılan talebin kesinlikle yetkili bir kaynaktan geldiğini doğrulamak için karma şeklinde dijital imza)

İstek başarılı olursa, API her zaman iki değişken döndürür:

1. status = true (başarı durumu)
2. data (API'den veri dizisi içeren json dizesi)

İstek başarısız olursa API, değişkenleri gösterir:

1. status = false (hata durumu)
2. error (hatayı açıklayan metin dizisi)

Her API isteği, isteğin dijital imzası olan bir karma değişken içermelidir.

hash = md5($json . $time . $salt)

• md5, sha256, bcrypt — mevcut şifreleme algoritmaları
• $json — istek verileriyle json dizesi
• $time — zaman "GG.AA.YYYY SS:DD:SS" biçiminde
• $salt — platform API'si için sabit benzersiz değer ("tuz")