English · 简体中文 · Español · Português (BR) · Italiano · Français · Deutsch · 🌐 Türkçe · Tiếng Việt · ไทย · العربية
Perfex CRM için REST API modülü için kullanıma hazır Postman koleksiyonu, kod parçacıkları (cURL, PHP, Python, JavaScript) ve bir kaynak kataloğu — Perfex CRM'i yapay zeka ajanları ve üçüncü taraf uygulamalarla bağlamanın en hızlı yolu.
Perfex CRM REST API, temiz bir HTTP/JSON arayüzü üzerinden müşterileri, potansiyel müşterileri, faturaları, teklifleri, projeleri, görevleri ve daha fazlasını okumanıza ve yazmanıza olanak tanır — CRM entegrasyonu, otomasyon ve özel uygulamalar için mükemmeldir. v3.0, yapay zeka ajanları için bir MCP sunucusu, üretim düzeyinde webhook'lar, hazır Zapier / Make / n8n yoklaması (polling), toplu (batch) işlemler ve daha akıllı liste uç noktaları ekler. Bu depo, Themesic Interactive tarafından geliştirilen REST API for Perfex CRM modülünün pratik yol arkadaşıdır: kopyala-yapıştır örnekler, içe aktarılabilir bir Postman koleksiyonu ve tam bir uç nokta kataloğu.
- 🧩 Modülü edinin: https://themesic.com/product/rest-api-module-for-perfex-crm-connect-your-perfex-crm-with-third-party-applications/
- 📖 API kılavuzu / canlı dokümantasyon: https://perfexcrm.themesic.com/apiguide/
- 🧾 OpenAPI 3.0 şeması:
GET https://yourdomain.com/api/openapi
| Özellik | Uç nokta | Ne işe yarar |
|---|---|---|
| 🤖 MCP sunucusu | POST /api/mcp |
Model Context Protocol (JSON-RPC 2.0) — Claude Desktop, ChatGPT, Cursor, n8n AI Agent ve herhangi bir MCP istemcisine izin filtreli 148 CRM aracı sunar |
| 🪝 Webhooks 2.0 | /api/webhooks |
124 olay, REST yönetimi, yeniden denemelerle eşzamansız teslimat, SSRF koruması, HMAC ile imzalanmış istekler |
| 🔌 Otomasyon (yoklama) | /api/zapier/* |
Zapier, Make.com, n8n ve yoklama tabanlı herhangi bir araç için hazır yoklama tetikleyicileri |
| ⚡ Batch | POST /api/batch |
Tek istekte en fazla 50 işlem (MCP ile aynı araç adları) |
| 📚 Bilgi Bankası | /api/knowledge_base |
Makaleler + gruplar için CRUD |
| 🗒️ Notlar | /api/notes |
12 varlık türü genelinde çok biçimli (polymorphic) notlar |
| 📄 Daha akıllı listeler | herhangi bir liste uç noktası | İsteğe bağlı ?page=&per_page=, ?fields=, ?sort=, ?created_after=&created_before= |
| 🛡️ Güvenli yazma işlemleri | herhangi bir POST |
Idempotency-Key ile yeniden oynatma, PUT üzerinde bilinmeyen alanların yok sayılması, X-RateLimit-* başlıkları |
Her şey isteğe bağlıdır ve geriye dönük uyumludur: yeni parametreler içermeyen istekler, önceki ile tam olarak aynı yanıtı döndürür.
| Klasör | İçeriği |
|---|---|
postman/ |
İçe aktarılabilir Postman koleksiyonu + ortamı ({{base_url}}, {{authtoken}}) — artık MCP, Webhooks, Batch, Automation, Knowledge Base ve Notes ile |
snippets/curl/ |
En yaygın çağrılar için kopyala-yapıştır curl komutları |
snippets/php/ |
PHP (cURL) örnekleri |
snippets/python/ |
Python (requests) örnekleri |
snippets/javascript/ |
JavaScript / Node (fetch) örnekleri |
docs/ |
Kimlik doğrulama, sayfalama ve filtreleme, webhook'lar, MCP, otomasyon, hatalar ve durum kodları |
Her parçacık dili için müşteriler, faturalar, potansiyel müşteriler örneklerinin yanı sıra v3 özellikleri olan webhooks, mcp, batch, automation, knowledge_base ve notes için örnekler ve sayfalama, alan seçimi ile sıralamayı gösteren bir list_features dosyası bulunur.
Perfex CRM REST API'sine yapılan her istek Authtoken başlığı ile kimlik doğrulaması yapar. Perfex yönetici panelinizde
REST API modülünü
etkinleştirdikten sonra API → API Management altında bir token oluşturun,
ardından API'yi https://yourdomain.com/api/... adresinden çağırın:
curl -H "authtoken: YOUR_API_TOKEN" https://yourdomain.com/api/customersBu, müşteri listesini JSON olarak döndürür. Başlık ile sorgu parametresi kimlik doğrulaması karşılaştırması için
docs/authentication.md, aynı çağrının PHP, Python ve JavaScript'teki hali için ise snippets/ bölümüne bakın.
- Postman'i açın → Import →
postman/perfex-rest-api.postman_collection.jsondosyasını bırakın. postman/perfex-rest-api.postman_environment.jsonortamını içe aktarın.base_urldeğerinihttps://yourdomain.com/apiveauthtokendeğerini kendi token'ınıza ayarlayın.- Herhangi bir isteği seçin ve Send düğmesine basın.
Herhangi bir MCP istemcisini (Claude Desktop, Cursor, ChatGPT, n8n AI Agent) POST https://yourdomain.com/api/mcp adresine yönlendirin
ve authtoken başlığınızı gönderin. Sunucu, CRM'iniz için izin filtreli araçları sunar. Bkz.
docs/mcp.md ve snippets/curl/mcp.sh.
Tüm CRUD uç noktaları RESTful bir kurala uyar: GET liste, GET /:id tekil, POST oluştur,
PUT /:id güncelle, DELETE /:id sil — https://yourdomain.com/api temel yolu altında.
| Kaynak | Temel yol | Tipik işlemler |
|---|---|---|
| Müşteriler | /api/customers |
liste, getir, oluştur, güncelle, sil |
| Kişiler | /api/contacts |
liste, getir, oluştur, güncelle, sil |
| Potansiyel müşteriler | /api/leads |
liste, getir, oluştur, güncelle, sil |
| Faturalar | /api/invoices |
liste, getir, oluştur, güncelle, sil |
| Teklifler | /api/estimates |
liste, getir, oluştur, güncelle, sil |
| Alacak Dekontları | /api/credit_notes |
liste, getir, oluştur, güncelle |
| Ödemeler | /api/payments |
liste, getir, oluştur |
| Teklif Belgeleri | /api/proposals |
liste, getir, oluştur, güncelle, sil |
| Sözleşmeler | /api/contracts |
liste, getir, oluştur, güncelle, sil |
| Projeler | /api/projects |
liste, getir, oluştur, güncelle, sil |
| Görevler | /api/tasks |
liste, getir, oluştur, güncelle, sil |
| Kilometre Taşları | /api/milestones |
liste, getir, oluştur, güncelle, sil |
| Zaman Çizelgeleri | /api/timesheets |
liste, getir, oluştur, güncelle, sil |
| Abonelikler | /api/subscriptions |
liste, getir, oluştur, güncelle |
| Kalemler | /api/items |
liste, getir, oluştur, güncelle, sil |
| Giderler | /api/expenses |
liste, getir, oluştur, güncelle, sil |
| Personel | /api/staffs |
liste, getir, oluştur, güncelle, sil |
| Takvim | /api/calendar |
liste, getir, oluştur, güncelle, sil |
| Özel Alanlar | /api/custom_fields |
ilgili türe göre liste |
| Ortak (arama tabloları) | /api/common |
ülkeler, vergiler, para birimleri, durumlar … |
| Kaynak | Temel yol | Tipik işlemler |
|---|---|---|
| MCP sunucusu | /api/mcp |
POST JSON-RPC 2.0: initialize, tools/list, tools/call |
| Batch | /api/batch |
POST tek istekte en fazla 50 işlem |
| Webhooks | /api/webhooks |
liste, getir, oluştur, güncelle, sil, POST /:id/toggle, GET /events, GET /:id/logs |
| Otomasyon (yoklama) | /api/zapier |
GET /resources, GET /poll/:resource, GET /test/:resource |
| Bilgi Bankası | /api/knowledge_base |
liste, getir, oluştur, güncelle, sil; /groups |
| Notlar | /api/notes |
:rel_type/:rel_id ile listele, getir, oluştur, güncelle, sil |
Her kaynak için tam istek alanları resmi API kılavuzunda belgelenmiştir. Buradaki parçacıklar en yaygın akışları kapsar.
Her liste uç noktası isteğe bağlı sorgu parametrelerini kabul eder. Bunları eklerseniz bir { data, meta } zarfı alırsınız;
atlarsanız tam olarak eski dizinin (array) aynısını alırsınız.
# Page 2, 20 per page, only id + company, newest first, created this year
curl -H "authtoken: YOUR_API_TOKEN" \
"https://yourdomain.com/api/customers?page=2&per_page=20&fields=id,company&sort=-datecreated&created_after=2026-01-01"| Parametre | Örnek | Etkisi |
|---|---|---|
page, per_page |
?page=2&per_page=20 |
Sayfalama → { data, meta } |
fields |
?fields=id,company |
Yalnızca bu sütunları döndür |
sort |
?sort=-datecreated,company |
Sırala (- = azalan) |
created_after, created_before |
?created_after=2026-01-01 |
Tarih aralığı filtresi |
Bkz. docs/pagination-filtering.md ve
snippets/curl/list_features.sh.
Perfex CRM REST API'si yaygın olarak Perfex CRM'i yapay zeka ajanları ve üçüncü taraf uygulamalarla bağlamak için kullanılır:
- Yapay zeka asistanları (MCP) — Claude, ChatGPT veya Cursor'ın
/api/mcpüzerinden CRM'inizi okuyup güncellemesini sağlayın. - Zapier / Make / n8n — hazır yoklama tetikleyicileri (
/api/zapier/*) aracılığıyla kod gerektirmeyen otomasyon. - Webhook'lar — Perfex olaylarını (yeni fatura, yeni potansiyel müşteri, 124 olay) HMAC ile imzalanmış olarak Slack, Discord veya kendi arka ucunuza iletin.
- Google Sheets / Power Automate — müşterileri, faturaları veya ödemeleri elektronik tablolar ve panolarla senkronize edin.
- Özel uygulamalar ve portallar — Perfex verilerinizin üzerine bir mobil uygulama veya müşteri portalı oluşturun.
- Muhasebe ve e-ticaret — faturaları ve kalemleri harici faturalama veya mağaza platformlarıyla senkronize edin.
Bunların tümü REST API for Perfex CRM modülü tarafından desteklenir.
| Yöntem | Nasıl |
|---|---|
| Başlık (önerilen) | Authtoken: YOUR_API_TOKEN |
| Sorgu parametresi | ?authtoken=YOUR_API_TOKEN (hızlı testler / webhook'lar için kullanışlı) |
Token'lar API → API Management bölümünde oluşturulur ve kapsamlandırılır (kaynak bazlı izinler). Tüm ayrıntılar için bkz.
docs/authentication.md.
Perfex CRM'in bir REST API'si var mı? Evet. REST API for Perfex CRM modülü; müşteriler, potansiyel müşteriler, faturalar, teklifler, projeler, görevler ve daha fazlası için tam RESTful bir HTTP/JSON API'sinin yanı sıra bir v3 MCP sunucusu, webhook'lar, batch ve otomasyon uç noktaları ekler.
Perfex CRM'i yapay zeka ajanları / ChatGPT / Claude ile kullanabilir miyim?
Evet — v3, herhangi bir Model Context Protocol istemcisine izin filtreli CRM araçları sunan bir MCP sunucusu ile
POST /api/mcp adresinde gelir. Bkz. docs/mcp.md.
Perfex CRM API'si ile nasıl kimlik doğrulaması yaparım?
Token'ınızı Authtoken HTTP başlığında (veya bir ?authtoken= sorgu parametresi olarak) gönderin. Bkz.
docs/authentication.md.
Perfex CRM API'sinin temel URL'si nedir?
https://yourdomain.com/api — örneğin https://yourdomain.com/api/customers.
Perfex CRM'i Zapier, Make veya n8n'e bağlayabilir miyim?
Evet — v3'te /api/zapier/* altında hazır yoklama tetikleyicileri ve ayrıca webhook'lar bulunur. Bkz.
Popüler entegrasyonlar ve docs/automation.md.
Perfex CRM için bir Postman koleksiyonu var mı?
Evet — postman/perfex-rest-api.postman_collection.json
dosyasını ve birlikte gelen ortamı içe aktarın, base_url ve authtoken değerlerinizi ayarlayın ve istek göndermeye başlayın.
Perfex CRM API'si aracılığıyla nasıl fatura oluştururum?
Fatura alanları ve bir items[] dizisi ile POST https://yourdomain.com/api/invoices yapın — v3,
subtotal/total değerlerini otomatik hesaplar. Bkz. snippets/curl/invoices.sh.
Bu depo, ticari modülün bir örnekler yol arkadaşıdır:
REST API for Perfex CRM — connect your Perfex CRM with third-party applications Themesic Interactive tarafından.
- 🛒 Satın alın / daha fazla bilgi: https://themesic.com/product/rest-api-module-for-perfex-crm-connect-your-perfex-crm-with-third-party-applications/
- 📖 Dokümantasyon: https://perfexcrm.themesic.com/apiguide/
- 💬 Destek: https://themesic.com/support
Ek örnek katkıları memnuniyetle karşılanır — bkz. CONTRIBUTING.md.
Bu depodaki örnek kodlar MIT Lisansı altında yayımlanmıştır. "Perfex", ilgili sahibinin bir ticari markasıdır; REST API modülü Themesic Interactive'in ticari bir ürünüdür.