OvoCRM API Rehberi

Kendi sisteminizi OvoCRM’e bağlayın: firmalarınızı, faturalarınızı, siparişlerinizi ve daha fazlasını programatik olarak okuyun ve yazın.

Sürüm v1 · REST · JSON

1Başlarken

OvoCRM API’si standart bir REST arayüzüdür. İstekler JSON döner, HTTPS zorunludur. Bağlanmak için OvoCRM’den bir API anahtarı almanız gerekir — anahtarı biz tanımlayıp size iletiriz; kendiniz oluşturamazsınız. Anahtar, hesabınıza hangi verilere erişebileceğinizi belirler.

Temel adres

https://app.ovocrm.com/api/v1

Tüm uçlar bu adrese eklenir. Örneğin firmalar için: https://app.ovocrm.com/api/v1/companies

2Kimlik doğrulama

Her isteğe API anahtarınızı x-api-key başlığında ekleyin. Anahtar ovc_live_ ile başlar.

x-api-key: ovc_live_3f9a2b7c…

3Yetki: kapsamlar

Anahtarınızın yapabildikleri, OvoCRM’in size verdiği kapsamlarla sınırlıdır. Kapsam kaynak:işlem biçimindedir:

• companies:read — firmaları okuyabilir
• companies:create — yeni firma ekleyebilir
• invoices:read — faturaları okuyabilir · invoices:export — dışa aktarabilir

İşlemler: read (okuma), create (ekleme), update (güncelleme), delete (silme), export (dışa aktarma). Yetkiniz olmayan bir işlem denerseniz 403 alırsınız — bu bir hata değil, o kapsam size verilmemiş demektir. Ek yetki için OvoCRM ile iletişime geçin.

4Erişilebilir kaynaklar

Aşağıdaki kaynaklar API ile kullanılabilir. Her birinde GET … (liste) ve GET …/{id} (tek kayıt) çalışır; yazma işlemleri size verilen kapsama bağlıdır.

5Örnek istekler

Firmaları listele

curl "https://app.ovocrm.com/api/v1/companies?limit=20&q=teknik" \
    -H "x-api-key: ovc_live_3f9a2b7c…"

Yanıt — liste uçları sonuçları data içinde, sayfa bilgisini meta içinde döner:

{
  "data": [
    {
      "id": "cmsx…",
      "code": "F-003197",
      "name": "Teknik Part Plastik Makina Ltd.",
      "type": "CUSTOMER",
      "taxNumber": "1234567890",
      "taxOffice": "Yeşilyurt",
      "phone": "+90 212 …",
      "email": "info@…",
      "city": "İstanbul"
    }
  ],
  "meta": { "limit": 20 }
}

Tek firmayı getir

curl https://app.ovocrm.com/api/v1/companies/cmsx… \
    -H "x-api-key: ovc_live_3f9a2b7c…"

Faturaları listele

curl "https://app.ovocrm.com/api/v1/finance/invoices?limit=10" \
    -H "x-api-key: ovc_live_3f9a2b7c…"

Fatura kayıtları id, number, companyId, buyerName, total, documentType gibi alanlar içerir.

Sık kullanılan parametreler

• ?limit=20 — sayfa başına kayıt (varsayılan sınırlı)
• ?q=aranan — ada / koda göre arama (liste uçlarında)

6Hatalar

Hata gövdesi açıklayıcı bir message alanı içerir; sorunu çözmek için önce onu okuyun.

7Notlar ve sınırlar

• Tüm istekler HTTPS üzerinden yapılmalıdır.
• Anahtar başına hız sınırı uygulanır; toplu iş için istekleri makul aralıklarla gönderin.
• Anahtarınızın yetkisi anlıktır: OvoCRM verdiğiniz kapsamı değiştirirse yeni yetki birkaç dakika içinde geçerli olur.
• Yalnızca kendi hesabınızın verilerine erişirsiniz; başka firmaların verisi görünmez.
• Giden webhook mevcuttur — uygulamada API sayfasında tanımlanır; olaylar HMAC-SHA256 ile imzalı gönderilir. Sandbox (test) ortamı şu an yoktur.

OvoCRM API v1 · Bu rehber, size tanımlanan API anahtarıyla birlikte kullanılmak üzere hazırlanmıştır. API anahtarı talebi ve sorularınız için OvoCRM ekibiyle iletişime geçin.