Geliştiriciler için API

Geliştiriciler için API

Yazılımınızı kaynaklar, işleme, sonuçlar ve yönetim için açıkça tanımlanmış işlemlere bağlayın. Bu kılavuz, belgelenen sürüm sınırları dahilinde kullanılabilen API’yi açıklar. Kullanıcı, izinler, depolama ve krediler Rapportly hesabına bağlı kalır.

Entegrasyonunuzu üç adımda hazırlayın

1. 1
   Kullanıcı, ortam ve izinleri seçin

   Hesap → Entegrasyonlar bölümünü açın. Kurgusal simülatör için test anahtarı, kurgusal verilerle gerçek işlemler için ayrı üretim anahtarı kullanın. Yönetici yalnızca gereken izinleri ve uygun bütçeyi tanımlar.

2. 2
   Alınma ve hata durumlarını deneyin

   Önce simülatörü kullanın. Ardından API sözleşmelerini içe aktarın ve sentetik örnekleri inceleyin. Gizli bilgiler sunucunuzda kalır; koleksiyonda değişiklikler varsayılan olarak kapalıdır.

3. 3
   Bir isteği baştan sona izleyin

   Girdiyi ve istek kimliğini saklayın; başlangıç ile son durumu kontrol edin, sonucu okuyun, mevcut dosyayı indirin ve tüketimi inceleyin. Bunu yalnızca onaylanmış ortamda yapın.

API anahtarınızı oluşturun

Temel adres

https://api.rapportly.io/api/rapportly/v1

Anahtar bir kullanıcıya aittir

Anahtar tek bir kullanıcının izinlerini devreder. Yönetici ortamı, izin tavanını, aylık bütçeyi ve son geçerlilik tarihini belirler. Üye hazırlanan anahtarı etkinleştirir ve gizli değeri bir kez görür. Her istek ayrıca güncel kullanıcı, paket ve nesne izinlerini denetler. Anahtar yönetimi kullanıcı oturumu, üretim işlemleri API anahtarı kullanır. Gizli bilgileri sunucuda saklayın; kaybolan anahtarı Hesap → Entegrasyonlar üzerinden iptal edin. Zapier olaylarının ayrı sözleşmesi vardır.

GET https://api.rapportly.io/api/rapportly/v1/ping
Authorization: Bearer rply_<jouw_sleutel>

Somut sözleşmeler ve örnekler kullanın

Üretim OpenAPI dosyası kaynak sözleşmelerini açıklar, kısmi girdi veya yanıtları işaretler. Envanter açık şemaları gösterir. Postman koleksiyonu geçersiz adres, boş anahtarlar ve kapalı değişikliklerle başlar. İncelemek için içe aktarın; onaylanmış ortamda kurgusal verileri bilinçli gönderin. İçe aktarma henüz test edilmedi.

• Üretim OpenAPI tanımını indirin
• Sentetik Postman koleksiyonunu indirin
• Kaynaktan indirmeye kadar adımları indirin
• Açık bölümleri içeren şema envanterini indirin

Önce kurgusal görevlerle alıştırma yapın

Test anahtarı oluşturup devam eden görevleri, sonuçları, hataları ve yetersiz bütçeyi deneyin. Simülatör sabit örnekler kullanır ve kredi harcamaz.

1. Hesap → Entegrasyonlar içinde denemek istediğiniz izinlerle Test anahtarı oluşturun veya etkinleştirin.
2. GET /test/scenarios isteği yapıp yanıttan bir işlem seçin. Liste güncel izinlerinize uyar.
3. POST /test/opdrachten isteğinde yalnızca actie ve scenario gönderin: succes, verwerking_mislukt, creditbudget_bereikt veya toegang_geweigerd. Her yeni alıştırma kendi Idempotency-Key değerini kullanır.
4. opdracht_id değerini saklayın. bezig durumunda yaklaşık beş saniye sonra GET /test/opdrachten/{id} okuyun. Durumu daima kontrol edin: HTTP200 başarısız işleme içerebilir.

POST https://api.rapportly.io/api/rapportly/v1/test/opdrachten
Authorization: Bearer rply_test_<jouw_testsleutel>
Idempotency-Key: test-rapport-0001
Content-Type: application/json

{
  "actie": "rapport.start",
  "scenario": "succes"
}

Örnek, işlem listenizde rapport.start gerektirir. Bağlantı sorununda aynı girdi ve Idempotency-Key ile tekrarlayın.

• Simülatör kılavuzunu indirin
• Postman alıştırma koleksiyonunu indirin
• Simülatör OpenAPI dosyasını indirin

Yalnızca gereken veriyi alın

Erişilebilir müşteri klasörlerini, görüşmeleri ve raporları arayın. /acties işlemleri ve izinleri, /gebruik bütçe ve ayırmaları, /verzoeken teknik geçmişi gösterir. Devam eden işlemenin henüz sonucu yoktur. Rapor bağlantıları 15 dakika geçerlidir; yeni bağlantı için raporu tekrar okuyun.

Müşteri yönetimini güncelle

Yazılımın ofis şablonlarını düzenleyebilir, kişisel aramaları kaydedebilir, bir ziyareti kayda geçirebilir ve bir takip süreci oluşturabilir. Uygun yönetim yetkilerini kullan ve her değişikliği onayla. Önce güncel sürümü oku ve yanıt kaybolursa aynı istek kimliğini koru. Eski bir isteğin tekrarı daha yeni bir değişikliği geri almamalıdır. Üretim testi aramaları, ziyaretleri ve takip süreçlerini, temizlik ve anahtar iptali dahil kontrol eder. Ofis şablonları bu testte yalnızca okunmuştur; yazma işlemleri yerel olarak ve CI ortamında test edilmiştir. İndirilebilir kılavuz dört yolu ve bunlara ilişkin kanıtların sınırlarını açıklar.

Kaydedilmiş iki sürümü karşılaştır

Aynı kayıtlı rapor metni alanının veya görüşme alanının mevcut iki sürüm numarasını, yeni yapay zekâ işlemi olmadan karşılaştır. Bu sözleşme yerel olarak ve CI ortamında test edilmiştir; CRM üretim testi karşılaştırmanın üretimdeki davranışını kanıtlamaz. Eksik geçmiş, güncel metinle tamamlanmaz. Uzun farklar, kısaltıldığı açıkça belirtilerek her taraf için en fazla 8000 karaktere kısaltılır. PowerPoint, teklif hesaplamaları, eşlik eden mektuplar veya biçimlendirme karşılaştırılmaz. Güncel okuma yetkileri ve gizlilik koşulları geçerli olmaya devam eder.

Önceden maliyet tahmini isteyin

POST /generatieplan rapor, teklif veya görüşme paketi için beklenen adımları ve kredileri gösterir. gebruik:lezen kullanın. Hesaplama ve ekip ayarları web sitesiyle aynıdır.

Tahmin işleme başlatmaz ve kredi düşmez. Garanti edilmiş azami fiyat değildir. Henüz bilinmeyen dosya okuma maliyetleri gibi belirsizlikleri gösterin. Başlangıç izinleri ve kredileri yeniden denetler.

Tahmin kılavuzunu ve örnekleri indirin

Yazılımınızdan işlem başlatın

API dosya, belge, yükleme, ses, transkripsiyon, müşteri klasörü, stil, çıktı, iş akışı, Excel ve hedefli mesaj işlemlerini bağlar. Her yolun kendi girdisi, izinleri, onayı ve sürüm denetimi vardır. Mevcut işleme ve kredi hesaplaması geçerlidir. Başlangıç yanıtı alındığını gösterir; ardından durumu okuyun. Envanter açık sözleşmeleri belirtir.

Önce bir dosya oluşturun

Bir UUID oluşturup saklayın. PUT /dossiers/{id} isteğini yalnızca naam ile, en fazla 200 karakter olarak gönderin. 201 oluşturma, 200 aynı isteğin tekrarıdır. Dosya anahtarın kullanıcısına ve kuruluşuna aittir, kredi harcamaz. Farklı girdi 409, erişilemeyen veya silinen dosya 404 döndürür. GET /dossiers/{id}, okuma izniyle naam ve klant_id alanlarını okur.

PUT https://api.rapportly.io/api/rapportly/v1/dossiers/00000000-0000-4000-8000-000000000002
Authorization: Bearer rply_<jouw_sleutel>
Content-Type: application/json

{ "naam": "Voorbeeldproject" }

Rapor, teklif veya sunum

dossierId ve notities ile başlayın. tier isteğe bağlıdır: basis, standaard veya max. Stil profili yoksa nötr tasarım kullanılır. Erişilebilir stijlprofielId, klantId, bronOpnameIds ve taal ekleyebilirsiniz. Stil belge türüne uygun olmalıdır. Teklifler şirket ayarlarını ve güvenli numaralandırmayı kullanır; API teklifi müşteriye göndermez.

POST https://api.rapportly.io/api/rapportly/v1/rapporten
Authorization: Bearer rply_<jouw_sleutel>
Idempotency-Key: crm-rapport-2026-0001
Content-Type: application/json

{
  "dossierId": "00000000-0000-4000-8000-000000000002",
  "notities": "Team Atlas besprak de training. Noor plant de volgende bijeenkomst op donderdag.",
  "tier": "standaard"
}

versie_id değerini saklayın ve teklifler ile sunumlar için de GET /rapporten/{versie_id} üzerinden izleyin. klaar durumunda resultaat mevcut dosyaları içerir: PDF için export_url, Word için export_url_docx, PowerPoint için export_url_pptx. Bağlantılar 15 dakika geçerlidir. mislukt durumunda başka anahtarla otomatik yeni işlem başlatmadan önce işleme ve tüketimi kontrol edin.

Kaynaktan indirmeye kadar adımları indirin

Kendi stil örneklerinizi yükleyin

Bir ila üç örnek dosyayı tam takım olarak gönderin. Rapportly web sitesiyle aynı dosya ve stil kontrollerini kullanır. Depolama ve krediler bağlı kullanıcıya aittir.

1. Dosyaları, adı, belge türünü, kişisel veya ekip kapsamını, açık onayı ve sabit görev kimliğini gönderin. Ekip stili yönetici veya ekip lideri gerektirir.
2. Alındı kimliğini saklayın ve durumu okuyun. Alındı, tam takımın saklandığını gösterir; önizleme kontrolü ve onay daha sonra gelebilir.
3. Kesintiden sonra ikinci stil oluşturmadan aynı isteği tam olarak tekrarlayın. Eksik yüklemeler otuz gün boyunca tekrarlanabilir, sonra kontrollü biçimde temizlenir.

Stil örnekleri, multipart ve hata kılavuzunu indirin

Takvim veya posta kutusu bağlayın

Kullanıcı Google veya Microsoft’ta kendisi onay verir. Yazılım isteği izler ve bağlantıyı bilinçli olarak durdurabilir. Sağlayıcı parolaları ve tokenları yanıtta yer almaz.

Bağlantılar için verbindingen:beheren, randevular için agenda:lezen kullanın. Gönderim ayrıca gönderme izni ve açık istek gerektirir.

İstek numarasını, görev kimliğini ve güncel temeli saklayın. Kayıp istekleri tam olarak tekrarlayın; eski bağlantı kesme isteği daha yeni bağlantıyı silemez.

API, yönetim ve gönderme izinleriyle varsayılan posta kutusunu seçebilir. Önce güncel seçimi ve bağlantıyı okuyun. Eski tekrar yeni seçimi değiştirmez; mevcut gönderim görevleri gönderenini korur.

Onay, randevu, bağlantı kesme ve kurtarma adımlarını indirin

Metinden görüşme sonuçları

En az yüz karakterlik transkript gönderin. Sonucu gesprek_id ile takip edin. İsteğe bağlı: titel, tier, klantId ve taal.

POST https://api.rapportly.io/api/rapportly/v1/gesprekken
Authorization: Bearer rply_<jouw_sleutel>
Idempotency-Key: crm-gesprek-2026-0001
Content-Type: application/json

{
  "transcript": "Team Atlas bespreekt uitsluitend een fictieve oefening. Het team plant een training en verzamelt algemene voorbeeldvragen zonder klantgegevens.",
  "titel": "Kennismaking"
}

Mevcut dil varyantlarını okuma

Mevcut dil sonuçlarını oku. Başlatma, duraklatma, sürdürme ve kurtarma için açıklanan iş akışı yolları yerel olarak ve CI ortamında test edilmiştir; CRM üretim testi bu dil işlemeyi doğrulamaz. Bunları yalnızca bu amaçla kullanıma açılmış bir ortamda kullan. İlk kullanıcı, anahtar, kaynak ve maliyetler isteğe bağlı kalır. Kaynağın güncel durumu, yetkiler, bütçe ve doğrulanmış hesaplaşma gerekli olmaya devam eder; süresi dolmuş veya silinmiş bir kaynak yeni bir başlatma yetkisi vermez. İkinci dil etkinleştirilmiş toplu işleme, devralınan ayarlar dahil, kapalı kalır. Eksik tek bir çeviri sonucunun ücretli olarak tamamlanması hâlâ kapsam dışıdır.

GET https://api.rapportly.io/api/rapportly/v1/gesprekken/00000000-0000-4000-8000-000000000001/taalvarianten
Authorization: Bearer rply_<jouw_sleutel>

İşleme tamamlandığında bildirim alın

Rapportly sunucunuza teknik referanslar gönderebilir. İlerlemeyi sürekli sorgulamadan içeriği daha sonra uygun okuma izinleriyle alın.

1. HTTPS alıcısı oluşturup webhooks:beheren izniyle POST /webhooks üzerinden kaydedin. İlgili işlemler için aynı üretim anahtarını kullanın.
2. İmzayı özgün mesaj baytları üzerinden doğrulayın ve her olay kimliğini benzersiz saklayın. Bildirimi sonraki görevle birlikte güvenle kaydettikten sonra onaylayın. Tekrar ikinci bir görev oluşturmamalıdır.
3. GET /webhook-afleveringen ve teslim ayrıntılarını okuyun. Geçici hatalar en fazla sekiz kez yeniden denenir; ek bir tur isteyebilirsiniz. Kabul edildi, yalnızca sunucunuzun aldığını gösterir. Sonraki işlemi orada kontrol edin.

• Webhook sınırları ve kurtarma kılavuzunu indirin
• İmza doğrulama Node.js örneğini indirin

Simülatör gerçek bildirim göndermez. Alıcınızı kurgusal veriler ve ayrı üretim bağlantısıyla deneyin. Örnek bildirimi doğrular; sunucunuz saklama ve sonraki işlemleri yürütür.

Hata kodu ne anlama gelir?

Anahtarı ve müşteri verilerini koruyun

• Anahtarı yalnızca sunucunuzda kullanın; herkese açık tarayıcı kodunda kullanmayın.
• Her entegrasyon için ayrı anahtar kullanın ve eskilerini iptal edin.
• Anahtarları, sonuçları veya geçici bağlantıları herkese açık günlüklere ya da sohbetlere koymayın.
• Alınan müşteri verilerini kendi sisteminizin erişim kurallarına göre saklayın.