+90 (216) 222 25 25

FaxMAX API

FaxMAX

Kullanıcı İşlemleri


Baz Metod
 Core.users
Tüm Metodlar
MetodAçıklama
Core.users.comboÖzet liste döner(ComboBox'larda kullanmak için).
Core.usersTam liste olarak döner(Tablolarda kullanmak için).
Core.users.editVar olan kaydı güncelleme içindir.
Core.users.createYeni kayıt eklemek içindir.
Core.users.removeKaydı silmek içindir.

Core.users.combo

JSON olarak şu şekilde bilgiler gönderilir:
{
    "jsonrpc":"2.0",
    "id":"fe012e8c-2d2f-47da-b7bb-9d90ee611eb4",
    "method":"Core.users.combo",
    "params":{
        "token_":[TOKEN],
        "user_id": Login'de dönen kullanıcı kodu
    }
}

Yukarıdaki JSON Verisini(string olarak) aşağıdaki şekilde gönderebilirsiniz:

 
curl -s -k -i -X POST -F data=JSON VERİSİ 'https://DOMAIN/api/v1'
         
 import json
import requests
r = requests.post('https://DOMAIN/api/v1',
                  data={'data': JSON VERİSİ}, verify=False)
print r.status_code, r.text
             
 $ch = curl_init();
curl_setopt_array($ch, array(
    CURLOPT_URL => "https://DOMAIN/api/v1",
    CURLOPT_HEADER => true,
    CURLOPT_POST => 1,
    CURLOPT_POSTFIELDS => array( "data" => JSON VERİSİ )) ), CURLOPT_RETURNTRANSFER => true ));
$result = curl_exec($ch);
curl_close($ch);
echo $result;  
 private async void Button_Click(object sender, RoutedEventArgs e)
{
    HttpStringContent stringContent = new HttpStringContent( JSON VERİSİ,
        UnicodeEncoding.Utf8, "application/json");
    HttpClient client = new HttpClient();
    HttpResponseMessage response = await client.PostAsync( "https://DOMAIN/api/v1", stringContent);
    string responseBody = await response.Content.ReadAsStringAsync();
    Console.WriteLine (responseBody);
}
 
 import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.entity.mime.content.FileBody;
import org.apache.http.entity.mime.content.StringBody;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.File;
import org.apache.http.conn.ssl.*;
import org.apache.http.impl.client.*;
import java.security.cert.X509Certificate;
import java.security.cert.CertificateException;
import org.apache.http.conn.scheme.*;
import org.apache.http.impl.conn.tsccm.*;
import org.apache.http.conn.*;

//export CLASSPATH=./httpcomponents-client-4.5.1/lib/*:.

public class ApiSendFax {
	public static void main(String[] args) throws Exception {
        /* Patch ssl hostname validation */
        SSLSocketFactory sf = new SSLSocketFactory(new TrustStrategy(){
            @Override
            public boolean isTrusted(X509Certificate[] chain,
                    String authType) throws CertificateException {
                return true;
            }
        }, new AllowAllHostnameVerifier());

        SchemeRegistry registry = new SchemeRegistry();
        registry.register(new Scheme("https",8444, sf));
        ClientConnectionManager ccm = new ThreadSafeClientConnManager(registry);
        /* end of patch */

        CloseableHttpClient httpclient =  new DefaultHttpClient(ccm);
        try {
            HttpPost httppost = new HttpPost("https://DOMAIN/api/v1");
            httppost.setEntity(new StringEntity(JSON VERİSİ, ContentType.create("application/json")));
            CloseableHttpResponse response = httpclient.execute(httppost);
            try {
                System.out.println(response.getStatusLine());
                HttpEntity resEntity = response.getEntity();
                if (resEntity != null) {
                    System.out.println("Response content length: " + resEntity.getContentLength());
                }
                EntityUtils.consume(resEntity);
            } finally {
                response.close();
            }
        } finally {
            httpclient.close();
        }
    }
}
 
 $.ajax({
    async: true,
    type: 'POST',
    dataType: 'json',
    url: "https://DOMAIN/api/v1",
    data: JSON VERİSİ,
    cache: false,
    success: function(data, textStatus, jqXHR){
        console.log(data.result);
    },
    // JSON-RPC Server could return non-200 on error
    error: function(jqXHR, textStatus, errorThrown){
    }
});
 
 func main() {
    var jsonStr = []byte(JSON VERİSİ)
    req, err := http.NewRequest("POST", "https://DOMAIN/api/v1", bytes.NewBuffer(jsonStr))
    req.Header.Set("Content-Type", "application/json")
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    fmt.Println("response Status:", resp.Status)
    fmt.Println("response Headers:", resp.Header)
    body, _ := ioutil.ReadAll(resp.Body)
    fmt.Println("response Body:", string(body))
} 

JSON params içeriği
Parametre Zorunlu? Açıklama
token* Evet** Giriş için kullanılacak TOKEN bilgisi
* TOKEN yerine username ve password bilgileri gönderilebilir.
** Eğer username ve password belirtilmemiş ise TOKEN mutlaka belirtilmelidir.
account_id Hayır Hesap ID'si. Eğer gönderilmez ise veya boş olursa, aktif hesap ID'si kullanılır(Fax.accounts->view) hakkınız var ise).

Core.users

JSON params içeriği
Parametre Zorunlu? Açıklama
token* Evet** Giriş için kullanılacak TOKEN bilgisi
* TOKEN yerine username ve password bilgileri gönderilebilir.
** Eğer username ve password belirtilmemiş ise TOKEN mutlaka belirtilmelidir.
page_length Evet Dönülecek kayıt sayısı(sayfa uzunluğu)
start Evet Kaçıncı satırdan itibaren kayıtlar gelsin?
order_by Evet Sıralama hangi sütuna göre yapılsın?
order_dir Evet Sondan başa (DESC) mı, yoksa baştan sona doğru(ASC) mu olsun?
search Evet nane, first_name, last_name, username sütunları içinde geçen bir değeri aramak için kullanılabilir. Eğer arama yapılmayacaksa boş string gönderilmeli
flt Evet assigned_on sütunu için filtreleme amaçlı olarak kullanılabilir. Örnek filtreleme verisi:
"flt": {"rules":[
    {"field":"assigned_on","op":"ge","data":null},
    {"field":"assigned_on","op":"lt","data":null}
]} 
Kullanılabilecek operatörler:
eq =
gt >
ge >=
lt <
le <=
in IN (Liste içinde)
bt BETWEEN (İki değer arasında)

Core.users.edit

JSON params içeriği
Parametre Zorunlu? Açıklama
token* Evet** Giriş için kullanılacak TOKEN bilgisi
* TOKEN yerine username ve password bilgileri gönderilebilir.
** Eğer username ve password belirtilmemiş ise TOKEN mutlaka belirtilmelidir.
id Evet Güncellenecek kaydın ID'si.
roles Evet Role ID'leri.
name Evet Kullanıcı kayıt ismi.
roles Evet Array tipinde Role ID'leri. Örnek ['81489d14-60bc-4a50-b289-67d47c310ebc']
username Evet Kullanıcı kodu.
password Evet Kullanıcı şifresi.
is_active Evet Hesap aktif mi? Aktif:true, pasif:false
first_name Hayır Adı.
last_name Hayır SoyaAdı.
e_mail Hayır E-Posta adresi.
m2f_mails Hayır Mail2Fax için e-posta ile faks gönderebilecek E-Posta adresleri.
home_phone Hayır Ev telefonu.
work_phone Hayır İş telefonu.
gsm_phone Hayır Cep telefonu.
notes Hayır Notlar.
file_size_limit Hayır Disk kota büyüklüğü(KB).
first_inform_percent Hayır Disk kotasının yüzde kaçı dolunca ilk uyarı e-postası gönderilsin?
last_inform_percent Hayır Disk kotasının yüzde kaçı dolunca son uyarı e-postası gönderilsin?
trim_percent Hayır Disk kotasının yüze kaçı kadar silme işlemi yapılsın?
trim_at_percent Hayır Disk kotasının yüze kaçı dolunca silme işlemine başlansın?
fax_max_sessions Hayır Aynı anda en fazla açılabilecek çağrı sayısı.
has_secure_pdf Evet Güvenli PDF akif mi? Aktif:true, pasif:false
secure_pdf_password Evet Güvenli PDF akif ise, kullanılacak şifre
lang_code Hayır Arayüzde kullanılacak dil
timezone Hayır Arayüzde kullanılacak zaman dilimi
params Hayır Kullanıcının profil verileri. JSON olarak şu bilgileri gönderebilirsiniz:

        'mail_on_new_fax': True,
        'mail_on_failed_incoming_fax': True,
        'mail_on_failed_outgoing_fax': True,
        'mail_on_succeeded_outgoing_fax': True
mail_on_new_faxYeni gelen faks bilgisi e-posta ile bildirilsin mi?
mail_on_failed_incoming_faxBaşarısız gelen yeni faks bilgisi e-posta ile bildirilsin mi?
mail_on_failed_outgoing_faxBaşarısız giden faks bilgisi e-posta ile bildirilsin mi?
mail_on_succeeded_outgoing_faxBaşarılı giden faks bilgisi e-posta ile bildirilsin mi?

Core.users.create

JSON params içeriği
Parametre Zorunlu? Açıklama
token* Evet** Giriş için kullanılacak TOKEN bilgisi
* TOKEN yerine username ve password bilgileri gönderilebilir.
** Eğer username ve password belirtilmemiş ise TOKEN mutlaka belirtilmelidir.
name Evet Kullanıcı kayıt ismi.
roles Evet Array tipinde Role ID'leri. Örnek ['81489d14-60bc-4a50-b289-67d47c310ebc']
username Evet Kullanıcı kodu.
password Evet Kullanıcı şifresi.
is_active Evet Hesap aktif mi? Aktif:true, pasif:false
first_name Hayır Adı.
last_name Hayır SoyaAdı.
e_mail Hayır E-Posta adresi.
m2f_mails Hayır Mail2Fax için e-posta ile faks gönderebilecek E-Posta adresleri.
home_phone Hayır Ev telefonu.
work_phone Hayır İş telefonu.
gsm_phone Hayır Cep telefonu.
notes Hayır Notlar.
file_size_limit Hayır Disk kota büyüklüğü(KB).
first_inform_percent Hayır Disk kotasının yüzde kaçı dolunca ilk uyarı e-postası gönderilsin?
last_inform_percent Hayır Disk kotasının yüzde kaçı dolunca son uyarı e-postası gönderilsin?
trim_percent Hayır Disk kotasının yüze kaçı kadar silme işlemi yapılsın?
trim_at_percent Hayır Disk kotasının yüze kaçı dolunca silme işlemine başlansın?
fax_max_sessions Hayır Aynı anda en fazla açılabilecek çağrı sayısı.
has_secure_pdf Evet Güvenli PDF akif mi? Aktif:true, pasif:false
secure_pdf_password Evet Güvenli PDF akif ise, kullanılacak şifre
lang_code Hayır Arayüzde kullanılacak dil
timezone Hayır Arayüzde kullanılacak zaman dilimi
params Hayır Kullanıcının profil verileri. JSON olarak şu bilgileri gönderebilirsiniz:

        'mail_on_new_fax': True,
        'mail_on_failed_incoming_fax': True,
        'mail_on_failed_outgoing_fax': True,
        'mail_on_succeeded_outgoing_fax': True
mail_on_new_faxYeni gelen faks bilgisi e-posta ile bildirilsin mi?
mail_on_failed_incoming_faxBaşarısız gelen yeni faks bilgisi e-posta ile bildirilsin mi?
mail_on_failed_outgoing_faxBaşarısız giden faks bilgisi e-posta ile bildirilsin mi?
mail_on_succeeded_outgoing_faxBaşarılı giden faks bilgisi e-posta ile bildirilsin mi?

Core.users.remove

JSON params içeriği
Parametre Zorunlu? Açıklama
token* Evet** Giriş için kullanılacak TOKEN bilgisi
* TOKEN yerine username ve password bilgileri gönderilebilir.
** Eğer username ve password belirtilmemiş ise TOKEN mutlaka belirtilmelidir.
id Evet Silinecek kaydın ID'si. Array olarak birden fazla ID belirtilebilir.
BİZE YAZIN
BİZE YAZIN
 
*
*
*