FaxMAX API

Faxmax Hakkında

FaxMAX API Yardım'a hoşgeldiniz. FaxMAX web üzerinden faks gönderim ve alım servisidir. STH Operatörleri veya kurumsal kullanıcılar bu kullanım klavuzunu takip ederek sitelerinin ayarlarını yapabilir, kullanıcılarını yönetebilirler.

Bu klavuzdaki örnekleri çalıştırabilmek için geçerli bir kullanıcı kodu ve şifreniz olması gerekmektedir. Aksi belirtilmedikçe tüm API işlemlerinde JSON biçimi kullanılacak ve karakter kodlama da UTF8 olarak yapılacaktır. Tüm API istekleri aksi belirtilmedikçe POST metoduyla gönderilmelidir.

İstemci gereksinimleri

FaxMAX'ın API servislerini kullanmak için aşağıdaki işlemlerin desteklenmesi gereklidir:

JSON desteği ( JSON RPC veya uygun hazırlanmış JSON mesajı)
UTF-8 karakter kodlama
HTTPS bağlantı için SSL bağlantı

API Kullanıcı Girişi

Bütün API fonksiyonlarını çağırırken ya önceden alınmışsa token veya alınmadıysa kullanıcı kodu-şifre gönderilmelidir. Kullanıcı kodu ve şifre ile login alınca size token dönülecektir. Ayrıca şifre değişikliğinde de yeni token gönderilir.

API İstek Formatı

Tüm isteklerin gönderileceği URL:

https://[DOMAIN]/api/v1

Buradaki örneklerde JSONRPC kütüphanesi kullanmadan gönderimler için temel olarak kullanılan JSON formatı gösterilecektir. JSONRPC kütüphanesi kullanılan durumlarda JSONRPC'ye ait olan alanları zaten kütüphanenin kendisi göndereceğinden bu şekilde mesajları oluşturmak zorunda kalmazsınız. (Veya bu alanları oluşturan metodu kendiniz geliştirir ve kullanabilirsiniz)

JSON RPC formatında token içeren istek biçimi:

    {
        "jsonrpc":"2.0",
        "method":"[METOD]",
        "id":"8f0550d5-8e38-4a02-84a4-45c1a2dbc21b",
        "params":{
            "token_":"[TOKEN]",
            [DİĞER PARAMETRELER]
        }
    }

Veya, kullanıcı kodu ve şifre ile işlem yapılacaksa:

    {
        "jsonrpc":"2.0",
        "method":"[METOD]",
        "id":"8f0550d5-8e38-4a02-84a4-45c1a2dbc21b",
        "params":{
            "username":"[KULLANICI KODU]",
            "password":"[ŞİFRE]"
            [DİĞER PARAMETRELER]
        }
    }

İstekte gönderilen "id", random olarak ürelilecek UUID olmalıdır(JSON RPC formatının gereği) Size de bu id'yi içeren bir cevap dönülecektir.

API Cevap Formatı

POST ettiğiniz istek başarılı şekilde işlenirse sunucu size JSON formatında şu biçinde bir cevap dönecektir. Buradaki id parametresi istekte sizin gönderdiğiniz id parameteresiyle aynı değerdir.

    {
        "jsonrpc": "2.0",
        "id": "8f0550d5-8e38-4a02-84a4-45c1a2dbc21b",
        "result": {
            "message": {
                [METHOD SONUÇ VERİSİ]
            }
        }
    }

POST ettiğiniz istek başarısız olursa sunucu size JSON formatında şu biçimde bir cevap dönecektir.

    {
        "jsonrpc": "2.0",
        "id": "8f0550d5-8e38-4a02-84a4-45c1a2dbc21b",
        "error": {
            "code": 401,
            "data": null,
            "message": {"[ALAN ISMI]": "[HATA MESAJI]"},
            "name": "InvalidCredentialsError"
        }
    }

Dönen error.code değeri hatanın tipine göre değişiklik gösterir.

Dönen error.message kısmında hata mesajının kendisi olacaktır. Fakat tüm metodlarda bu şekilde nesne olarak gelmeyebilir, örneğin; birden fazla hata dönerken dizi içinde nesne tipi dönüşü de olabilir.

Tüm API fonksiyon listesine ve kullanım parametreleri ile temel kullanım açıklamalarına canlı olarak "Web Browsable API" arayüzünden erişebilirsiniz. Bu arayüzde API fonksiyonlarını canlı olarak kullanabilir, giden JSON datasını ve sunucunun döndüğü JSON datasını da görebilirsiniz.
Faxmax web brosable API interface