Bu özelliği kimler kullanabilir?
Enterprise planında kullanılabilir.
Web Uygulaması'nda Sahipler ve Yöneticiler tarafından erişilebilir.
Fax.Plus API'sini kullanmak için öncelikle API'nin hesabınıza erişmesine yetki vermeniz gerekir. Yetkilendirme işlemini tamamladıktan sonra hesabınızda oturum açabilirsiniz.
Kimlik doğrulama için iki farklı yöntem vardır:
- Kişisel erişim belirteçleri oluşturun ve kullanın.
- OAuth 2.0 akışını kullanın.
Kişisel Erişim Belirteci, Fax.Plus API'sine güvenli bir şekilde erişmek için kimlik doğrulama yöntemi olarak kullanılabilir. Bu belirteç dijital imza işlevi görür; API'mize yetkili istekler göndermenizi, faks göndermek ve faksınıza ait verileri almak gibi işlemler yapmanızı sağlar.
Yeni bir Kişisel Erişim Belirteci oluşturmak için şu adımları izleyin:
- Fax.Plus hesabınızda oturum açın ve kontrol panelinizdeki Ayarlar bölümüne gidin.
- Entegrasyonlar sekmesini bulun.
- Fax.Plus API altında Kişisel Erişim Belirteçleri öğesini bulun ve Yönet düğmesine tıklayın.
- Belirteç Oluştur düğmesine tıklayın ve belirteç adını, son kullanma tarihini ve kapsamları belirtin (belirteç için hem düzenleme hem de okuma kapsamlarını seçin).
- Kişisel Erişim Belirtecinizi hemen Kopyalayın; aksi halde onu bir daha göremezsiniz.
1. Adım: İlk kimlik doğrulama akışını ayarlayın
- Fax.Plus hesabınızda oturum açın ve kontrol panelinizdeki Ayarlar bölümüne gidin.
- Entegrasyonlar sekmesini bulun.
-
Fax.Plus API altında Etkinleştir düğmesine tıklayın ve aşağıdaki verileri not edin:
- Client ID (APIK- ile başlar)
- Client secret
- Redirect URI (herhangi biri)
- API'nin hesabınıza erişmesini yetkilendirme sürecini başlatmak için bu adımda verilen bağlantıya bir web tarayıcısı kullanarak tıklamanız yeterlidir. Bu bağlantı sizi gerekli izinleri verebileceğiniz bir ekrana yönlendirir: https://accounts.fax.plus/login?response_type=code&client_id=[client ID]&redirect_uri=[redirect URI]&scope=all
-
İzin verildikten sonra, yetkilendirme kodu bir URL parametresi olarak eklenmiş şekilde belirttiğiniz URL'ye yönlendirilirsiniz:
2. Adım: HTTP POST isteği gönderin
Erişimi başarıyla yetkilendirdikten sonra aşağıdaki URL'ye bir HTTP POST isteği gönderebilirsiniz: https://accounts.fax.plus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI].
İsteğinize aşağıdaki başlıkları eklediğinizden emin olun:
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
- Content-Type: application/x-www-form-urlencoded
İşlem tamamlandığında, 1 saat geçerli olan bir erişim belirteci (access token) ile süresiz geçerli bir yenileme belirteci (refresh token) içeren bir yanıt alırsınız.
Not: Fax.Plus hesabınızda Advanced Security Control etkinse, yenileme belirteci güvenlik düzenlemeleri uyarınca 30 gün geçerli kalır. Bu, yeni bir yenileme belirteci almak için işlemi her 30 günde bir tekrarlamanız gerektiği anlamına gelir.
3. Adım: Yeni erişim belirteci alın
Erişim belirtecinizin süresi dolduğunda, yenileme belirtecinizi kullanarak aşağıdaki URL'ye bir HTTP POST isteği göndererek yenisini alabilirsiniz: https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=[refresh token].
Bu işlem için aşağıdaki başlıkların eklenmesi gerekir:
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
Erişim belirtecini aldıktan sonra, sonraki tüm API çağrıları için aşağıdaki başlıklar gerekir:
-
- Authorization: Bearer [access token]
- x-fax-clientid: [client ID]