API ile faks göndermek için önce gerekli dosyalarınızı yüklemeniz, ardından bu dosyaları fakslamaya hazırlayıp iletimlerini zamanlamanız gerekir.
Faksınız zamanlandıktan sonra bir HTTP sunucusu kurabilir ve webhook mekanizmasından yararlanabilirsiniz. Bu yaklaşım, faks iletimi başarılı olduğunda da iletim başarısız olduğunda da bir HTTP mesajının gönderilmesini sağlar.
Not: İlk kimlik doğrulama sürecini tamamladığınızdan ve API'de başarıyla oturum açtığınızdan emin olun. Ek talimatlar için kılavuzumuza buradan ulaşabilirsiniz.
Bir dosya yüklemek için aşağıdaki URL'ye bir HTTP POST isteği başlatın: https://restapi.fax.plus/v3/accounts/[user ID]/files?format=[file format, 'pdf' or 'tiff']
İsteğinize aşağıdaki başlıkları eklediğinizden emin olun:
-
Content-Type:
multipart/form-data
-
Authorization:
Bearer [access token]
-
x-fax-clientid:
[client ID]
Gövde için:
{
"fax_file": [file]
}
Aşağıdaki örnekte, oturum açmış olan kullanıcının benzersiz kimliğini temsil etmek için kullanıcı kimliği olarak “self” kullanılmıştır:
Dosya başarıyla yüklendikten sonra, dosyanın Fax.Plus üzerindeki geçici konumuna giden bir yol alırsınız.
Yüklemeler tamamlandıktan sonra faksınızı göndermeye hazırlamaya başlayabilirsiniz. İşlemi başlatmak için aşağıdaki URL'ye bir HTTP POST isteği gönderin:
https://restapi.fax.plus/v3/accounts/[user ID]/outbox
İsteğinize aşağıdaki başlıkları eklediğinizden emin olun:
-
Authorization:
Bearer [access token] -
x-fax-clientid:
[client ID]
İstek gövdesi için:
{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}
Faks başarıyla zamanlandığında size bir Giden Kutusu Kimliği verilir. Bu kimlik, faks gerçekten gönderilmeden önce üzerinde değişiklik yapmak veya faksı silmek için kullanılabilir.
Not: API'miz ile faksların birden fazla kimliği vardır. Bu tasarım, faks iletiminin eşzamansız olarak çalışmasından kaynaklanmaktadır. Özellikle, giden bir faks iki ayrı kimlikle tanımlanır: faks başarıyla gönderilene kadar geçerli olan Giden Kutusu Kimliği ve faks başarıyla iletildikten sonra faksın kesin tanımlayıcısı hâline gelen Faks Kimliği.
Faksı zamanladıktan sonra, giden kutusundaki veya gönderilenler kategorisindeki faksların listesini inceleyerek durumunu izleyebilirsiniz.
Alternatif olarak, bir HTTP sunucusu kurup webhook kullanabilirsiniz. Bu, faks başarıyla gönderildiğinde veya gönderimde bir hata olduğunda bir HTTP mesajı gönderilmesini tetikler.
Webhook'u kurmak için şu adımları izleyin:
- Fax.Plus hesabınızda oturum açın ve Kontrol Panelinizdeki Ayarlar bölümüne gidin.
- Entegrasyonlar sekmesi altında WebHooks kutusunu bulun.
-
Gelen Fakslar ve Gelen Fakslar öğelerini bulun. Webhook'u değiştirmek için Yönet öğesine tıklayın.
Webhook'u kurduktan sonra, giden bir faks işlendiğinde aşağıdaki bildirimi alırsınız:
{
"hook": {
"id": "",
"event": "fax_sent",
"event_time": "2022-12-09 15:50:00",
"target": "http://www.example.com/callback/fax_sent"
},
"data": {
"id": "",
"pages": 1,
"from": "",
"to": "",
"start_time": "2022-12-09 15:50:00",
"file": "",
"file_name": "fax-from-1xxxxxxxxxxxx",
"cost": 1,
"status": "success"
}
}Bu mesaj size iletim zamanını bildirir, faks iletiminin başarılı olup olmadığını (“status” alanı aracılığıyla) gösterir ve benzersiz faks kimliğini sağlar. Bu faks kimliği, faks dosyasını almak veya faks onay raporu edinmek için kullanılabilir.