SOLIDWORKS Document Manager API, SOLIDWORKS dosyalarının özelliklerini okumak, düzenlemek ve dosya yönetimi işlemlerini otomatikleştirmek için kullanılan bir uygulama programlama arayüzüdür. SOLIDWORKS programını açmadan dosya bilgilerine erişilmesini sağlayarak özellikle toplu işlemlerde zaman kazandırır.
Bu makalede SOLIDWORKS Document Manager API’nin ne işe yaradığını, API anahtarının nasıl alınacağını, başvuru formunun nasıl doldurulacağını ve karşılaşılabilecek abonelik doğrulama hatasının çözümünü adım adım inceleyeceğiz.
SOLIDWORKS Document Manager API Ne İşe Yarar?
SOLIDWORKS Document Manager API, parça, montaj ve teknik resim dosyalarındaki çeşitli bilgilere erişmek ve dosya yönetimi işlemlerini otomatikleştirmek için kullanılır.
Bu API sayesinde:
- Dosya özelliklerini yönetebilirsiniz: Parça numarası, açıklama ve malzeme gibi özel özellikleri okuyabilir veya düzenleyebilirsiniz.
- Montaj referanslarını kontrol edebilirsiniz: Montajların hangi parça ve alt montaj dosyalarına bağlı olduğunu inceleyebilirsiniz.
- Konfigürasyon bilgilerine erişebilirsiniz: Dosyalardaki konfigürasyonları ve bunlara ait özellikleri görüntüleyebilirsiniz.
- Toplu işlemler gerçekleştirebilirsiniz: Çok sayıda SOLIDWORKS dosyasının özelliklerini tek tek açmadan kontrol edebilir veya güncelleyebilirsiniz.
- Otomasyon uygulamaları geliştirebilirsiniz: Dosya bilgilerini kullanan raporlama ve dosya yönetimi uygulamaları oluşturabilirsiniz.
Örneğin, yüzlerce SOLIDWORKS dosyasının parça numarası veya açıklama bilgisini güncellemeniz gerektiğinde, her dosyayı SOLIDWORKS üzerinde ayrı ayrı açmak yerine Document Manager API kullanan bir uygulama aracılığıyla bu işlemleri gerçekleştirebilirsiniz.
Bu sayede tekrarlayan işlemler için harcanan zamanı azaltabilirsiniz.
Not: Document Manager API, SOLIDWORKS’ün modelleme komutlarını kullanmak için değil, dosya bilgilerini yönetmek ve otomasyon işlemleri gerçekleştirmek için tasarlanmıştır.
SOLIDWORKS Document Manager API Anahtarını Kimler Alabilir?
Aktif SOLIDWORKS bakım anlaşmasına sahip firmalar, Document Manager API anahtarını ücretsiz olarak talep edebilir.
API anahtarı her SOLIDWORKS lisansı için bir adet ile sınırlı değildir. Aynı firmada birden fazla kullanıcı, kendi SOLIDWORKS hesapları üzerinden API anahtarı talebinde bulunabilir.
Anahtar talebinde bulunacak kullanıcıların hesaplarının, firmanın aktif SOLIDWORKS aboneliğiyle ilişkilendirilmiş olması gerekmektedir.
Ayrıca SOLIDWORKS’ün her yeni ana sürümü için güncel bir API anahtarı talep edilmelidir.
SOLIDWORKS Document Manager API Anahtarı Nasıl Alınır?
SOLIDWORKS Document Manager API anahtarı almak için öncelikle aktif bakım anlaşmasına sahip firmanızla ilişkilendirilmiş SOLIDWORKS hesabınızın bulunması gerekmektedir. Aşağıdaki adımları takip ederek başvuru formunu doldurabilir ve API anahtarı talebinizi kolayca oluşturabilirsiniz.
1. SOLIDWORKS API Anahtarı Talep Sayfasına Giriş Yapın
Öncelikle aşağıdaki bağlantıya tıklayınız:
SOLIDWORKS Document Manager API Key Request
Açılan sayfada SOLIDWORKS hesabınızla giriş yapmanız istenecektir.
Giriş işlemi için 3DEXPERIENCE ID (Dassault Systèmes hesabı) bilgileriniz kullanılmaktadır.
Henüz bir 3DEXPERIENCE hesabınız yoksa aşağıdaki makalemizde bulunan hesap oluşturma adımlarını takip edebilirsiniz:
3DEXPERIENCE Platform Kayıt ve Aktivasyon – TEKYAZ Blog
Hesabınızı oluşturduktan sonra API anahtarı talep sayfasına geri dönerek giriş yapınız.
Mevcut bir hesabınız bulunuyorsa yeniden hesap oluşturmanıza gerek yoktur.
2. Yeni API Anahtarı Talebi Oluşturun
Hesabınıza giriş yaptıktan sonra açılan sayfada New Key Request Form seçeneğine tıklayınız.
Bu seçenek üzerinden yeni bir Document Manager API anahtarı talebi oluşturabilirsiniz.
3. API Anahtarı Talep Formunu Doldurun
Açılan formda kullanıcı bilgileriniz, firma bilgileriniz, kullanılacak SOLIDWORKS sürümü ve API anahtarının kullanım amacıyla ilgili alanlar bulunmaktadır.
Kullanıcı ve Firma Bilgileri
E-posta adresinizi ve firma bilgilerinizi ilgili alanlara giriniz. E-posta adresinizin firmanızın SOLIDWORKS abonelik kayıtlarında bulunan adresle aynı olmasına dikkat ediniz.
ORGANIZATIONAL TYPE: Customer seçmeniz gerekmektedir.
PRODUCT VERSION: Kullanacağınız SOLIDWORKS sürümü seçmelisiniz. Her zaman en son sürümü seçmeniz önerilir.
3.1 API Anahtarı Yetkilerini Belirleyin
Formda bulunan Requested Functionality bölümünde, API anahtarını hangi işlemler için kullanacağınızı belirlemeniz gerekmektedir.
Aşağıdaki açıklamalara göre ihtiyacınız olan seçenekleri işaretleyebilirsiniz.
| Seçenek | Hangi Durumda Seçilmeli? |
|---|---|
| Basic | SOLIDWORKS dosyalarının özel özelliklerini (parça numarası, açıklama, malzeme vb.) okumak, düzenlemek veya dosya referanslarını kontrol etmek istiyorsanız seçiniz. |
| Previews | SOLIDWORKS dosyalarını açmadan önizleme görüntülerine erişmek istiyorsanız seçiniz. |
| DimXpert | Parça dosyalarındaki DimXpert ölçü ve tolerans bilgilerine erişmek istiyorsanız seçiniz. |
| Geometry Streams | SOLIDWORKS dosyalarındaki geometri ve gövde verilerine erişmek istiyorsanız seçiniz. |
| XML Streams | Dosyalarda bulunan XML veri akışlarını okumak veya yönetmek istiyorsanız seçiniz. |
| Tessellation | Modelin üçgen yüzey verilerini kullanan özel görüntüleme veya işleme uygulamaları geliştiriyorsanız seçiniz. |
Peki, hangilerini işaretlemelisiniz?
- Yalnızca dosya özelliklerini düzenleyecekseniz: Basic seçeneğini işaretleyiniz.
- Dosya özelliklerini yönetirken önizleme görüntülerini de kullanacaksanız: Basic ve Previews seçeneklerini işaretleyiniz.
- Ölçü ve tolerans bilgilerine erişecekseniz: Basic ve DimXpert seçeneklerini işaretleyiniz.
- Dosya bilgileri dışında geometri ve diğer özel verilere de erişecekseniz: İhtiyacınıza göre Geometry Streams, XML Streams ve Tessellation seçeneklerini de işaretleyebilirsiniz.
Önerimiz: API anahtarını hangi işlemlerde kullanacağınız henüz belli değilse ve farklı özellikleri denemek istiyorsanız formda sunulan tüm yetkileri talep edebilirsiniz. Böylece ileride farklı API işlevlerini kullanmak istediğinizde yetki eksikliğiyle karşılaşma ihtimalinizi azaltabilirsiniz.
Seçimlerinizi tamamladıktan sonra formun bir sonraki bölümüne geçebilirsiniz.
3.2 API Anahtarının Kullanım Amacını Belirtin
Formun bu bölümünde, API anahtarını hangi amaçla kullanacağınızı belirtmeniz gerekmektedir.
External distribution: SOLIDWORKS iş ortaklarına yöneliktir.
Internal use only: API anahtarını firmanızın kendi dosya yönetimi, otomasyon veya yazılım işlemlerinde kullanacaksanız bu seçeneği işaretleyiniz.
Specify Application: API anahtarını hangi uygulamada veya hangi amaçla kullanacağınızı belirtiniz. Örneğin, SOLIDWORKS dosyalarının özelliklerini yönetmek için kullanacaksanız SOLIDWORKS File Management yazabilirsiniz. Kullanım amacınıza göre farklı bir uygulama adı veya açıklama da girebilirsiniz.
Partner DM Category: API anahtarını kullanacağınız uygulamanın amacına uygun kategoriyi seçiniz.
| Seçenek | Hangi Durumda Seçilmeli? |
|---|---|
| Backup Software | SOLIDWORKS dosyalarının yedeklenmesi için |
| Business Intelligence | Dosya bilgilerinden raporlama ve analiz yapılması için |
| Configuration Management | Dosya konfigürasyonlarının yönetilmesi için |
| CRM Integration | Dosya bilgilerinin CRM sistemine aktarılması için |
| ECAD Integration | Elektronik tasarım yazılımlarıyla entegrasyon için |
| ERP Software | SOLIDWORKS dosya bilgilerinin ERP sisteminde kullanılması için |
| Other Applications | Diğer kategorilere girmeyen dosya yönetimi ve otomasyon işlemleri için |
| PLM Integration | Ürün yaşam döngüsü yönetimi sistemleriyle entegrasyon için |
| Printing Software | Teknik resimlerin veya belgelerin yazdırılması için |
| Project Management | Dosya bilgilerinin proje yönetimi süreçlerinde kullanılması için |
Hangi seçeneği işaretlemelisiniz?
SOLIDWORKS dosyalarının özel özelliklerini okumak, düzenlemek veya toplu dosya işlemleri gerçekleştirmek amacıyla API kullanacaksanız Other Applications seçeneğini tercih edebilirsiniz.
Farklı bir amaçla kullanacaksanız yukarıdaki açıklamalara göre uygun kategoriyi seçiniz.
Seçimlerinizi tamamladıktan sonra formun kalan alanlarını doldurarak başvurunuza devam edebilirsiniz.
3.3 API Anahtarı Talebini Gönderin
Formdaki tüm alanları doldurduktan sonra bilgilerinizi kontrol ediniz.
Kullanım koşullarını inceleyerek gerekli onayları verdikten sonra Submit butonuna tıklayınız.
Talebiniz SOLIDWORKS tarafından değerlendirilecektir.
Başvurunuz onaylandığında API anahtarınız, talep sırasında belirttiğiniz e-posta adresine gönderilecektir.
Değerlendirme süresi değişiklik gösterebilir.
Submit butonuna tıkladığınızda License Agreement (Lisans Sözleşmesi) penceresi açılacaktır. Sözleşme koşullarını inceleyerek kabul ediyorsanız Accept butonuna tıklayınız.
Lisans sözleşmesini kabul ettikten sonra API anahtarı talebiniz tamamlanacaktır. Açılan sayfada “Request submitted” (Talep gönderildi) mesajı görüntülenecektir. Bu mesaj, başvurunuzun başarıyla iletildiğini gösterir.
Başvurunuz SOLIDWORKS tarafından değerlendirilecek olup işlem tamamlandığında kayıtlı e-posta adresiniz üzerinden bilgilendirileceksiniz.
SOLIDWORKS Document Manager API Anahtarı Nasıl Kullanılır?
API anahtarı talebiniz onaylandığında, SOLIDWORKS tarafından kayıtlı e-posta adresinize bir API anahtarı gönderilecektir.
Bu anahtar, SOLIDWORKS dosyalarındaki bilgilere erişmek için kullanılan özel yazılımların çalışmasını sağlar.
Peki, API anahtarını nereye girmelisiniz?
API anahtarı doğrudan SOLIDWORKS programına girilmez. Anahtarın kullanılacağı yer, yapmak istediğiniz işleme ve kullandığınız yazılıma göre değişir.
Örneğin:
- Hazır bir program kullanıyorsanız: Programın API anahtarı veya lisans bilgisi isteyen bölümüne, size gönderilen anahtarı girmeniz gerekebilir.
- Firmanıza özel geliştirilmiş bir yazılım kullanıyorsanız: API anahtarının yazılıma tanımlanması için programı geliştiren kişi veya firmayla paylaşmanız gerekebilir.
- Kendi yazılımınızı geliştiriyorsanız: API anahtarını yazılımınızın Document Manager bağlantısında kullanmanız gerekir.
Önemli: API anahtarı tek başına çalışan bir program değildir. SOLIDWORKS dosyalarının bilgilerini okumak veya düzenlemek için bu anahtarı kullanabilen bir yazılıma ihtiyaç vardır.
API anahtarınızı aldıktan sonra, kullandığınız yazılımın ilgili bölümüne tanımlayarak işlemlerinize devam edebilirsiniz.
SOLIDWORKS Document Manager API Anahtarı Alırken “Abonelik Onayı Gerekli” Hatası
API anahtarı talep sayfasına giriş yaptığınızda bazı durumlarda “Abonelik Onayı Gerekli (Subscription Validation Required)” uyarısıyla karşılaşabilirsiniz.
Bu uyarı, SOLIDWORKS hesabınızın aktif abonelik hizmetine sahip firmanızla ilişkilendirilememesi veya gerekli abonelik erişiminin doğrulanamaması nedeniyle görüntülenebilir.
Abonelik Onayı Gerekli Hatası Nasıl Çözülür?
Bu hatayla karşılaşıyorsanız aşağıdaki kontrolleri gerçekleştirebilirsiniz:
- SOLIDWORKS hesabınızdan çıkış yapınız.
- Firmanızın SOLIDWORKS kayıtlarında bulunan e-posta adresinizle yeniden giriş yapınız.
- Birden fazla firma hesabıyla ilişkilendirilmişseniz doğru firma hesabını kullandığınızdan emin olunuz.
- Tarayıcınızı kapatıp yeniden açarak API anahtarı talep sayfasına tekrar giriş yapınız.
Bu işlemlere rağmen hata devam ediyorsa SOLIDWORKS hesabınızın firmanızın abonelik kayıtlarında yetkilendirilmesi gerekebilir.
Bu durumda firmanızın yetkili SOLIDWORKS yöneticisi veya TEKYAZ teknik destek ekibi aracılığıyla kullanıcı kaydınızın kontrol edilmesini sağlayabilirsiniz.
Kullanıcı hesabınızın doğru firma ve abonelik kayıtlarıyla ilişkilendirilmesinin ardından API anahtarı talep sayfasına yeniden giriş yapabilirsiniz.
SOLIDWORKS Document Manager API, dosya özelliklerinin yönetilmesi, referansların kontrol edilmesi ve tekrarlayan dosya işlemlerinin otomatikleştirilmesi için kullanılabilen bir araçtır.
Aktif SOLIDWORKS bakım anlaşmasına sahip uygun kullanıcılar, API anahtarını SOLIDWORKS’ün resmi internet sitesi üzerinden ücretsiz olarak talep edebilir.
API anahtarı talebi sırasında abonelik doğrulama veya erişim sorunlarıyla karşılaşmanız durumunda TEKYAZ teknik destek ekibinden yardım alabilirsiniz.
