Genel Bakış
API Hakkında
Nilvera API'leri, REST olarak tasarlanmıştır. API istek ve dönüşleri HTTP standartlarına uygun olarak geliştirilmiştir. Dokumanın ilerleyen sayfalarında Ortak Nesneler hakkında detaylı bilgiler verilmiştir.
API istek ve dönüş tiplerinde OAS 3.x standartları kullanılmıştır. İlgili API'lere ait tanımlayıcı dosyaları ile kendi uygulamalarınızı çok hızlı ve sorunsuz bir biçimde entegre edebilirsiniz.
API dokumantasyonları içerisinde tüm uçların açıklamaları, istek ve dönüş tipleri detaylıca açıklanmıştır.
API'leri kullanarak e-Fatura, e-Arşiv Fatura, e-İrsaliye, e-Serbest Meslek Makbuzu, e-Müstahsil Makbuzu, e-Adisyon özel entegratörlük hizmetlerimizi geliştirmiş olduğunuz ERP/Muhasebe sistemleri ve diğer uygulamalarınız ile entegre edebilirsiniz.
Test ve Canlı Ortam Hakkında
API'ler Canlı ve Test ortamı olarak ayrılmaktadır. Test ortamında üretilen anahtlar ile Canlı ortam anahtarları ve Firma bilgileri birbirinden ayrı olacaktır.
Test ortamı ile tüm entegrasyon tamamlandıktan sonra canlı hesap açılışları yapıldıktan sonra endpoint canlı ortama bakacak şekilde ayarlanması durumunda bir sorun yaşanmayacaktır.
Authentication ve Authorization
Tüm API'lerimizde yetkilendirme mekanizması olarak OAuth 2.0 kullanılmaktadır. Hizmetlere ait API'ler farklı uygulamalar olmasına karşın merkezi yetkilendirme otoritesi üzerinden API'leri kullanabilirsiniz.
API'lerde kullanılacak Token tipi JWT değil Reference tipindedir. Daha önceden edindiğiniz kullanıcı adı ve şifrenizle Portal uygulaması üzerinden API'lerde kullanmak üzere API Anahtarı üretmelisiniz.
Üretilen API Anahtarı sizin belirleyeceğiniz yetkilere (scope) sahip olacak ve sadece yetkisi olduğu işlemleri yapabilecek, belirttiğiniz süre dolduğunda da API Anahtarı geçersiz olacaktır.
API anahtarları Persisted Access Token şeklindedir. Bir anahtar ürettikten sonra bu anahtarı sürekli kullanabilir, Portal üzerinden erişimini anında sonlandırabilirsiniz.
Örnek : 9EE05B6564525810C86A32646DB46A26E20F4BCE32C0B13AB22AA78E70DC4F69
Not: API anahtarını servis çağrılarınızın Header alanında
Authorization:Bearer {API_ANAHTARI}şeklinde göndermeniz API nin sizi tanıması ve yetkilendirmesi için yeterli olacaktır.
