Hipcall API Anahtarı Nasıl Alınır ve İlk İstek Nasıl Gönderilir?

Genel bakış

Hipcall API, bulut santral sisteminizi kendi yazılımınıza bağlamanızı sağlar. API üzerinden çağrı başlatabilir, çağrı kayıtlarını çekebilir, arayan bilgisini temsilcinin ekranına iletebilir ya da çağrı yönlendirmelerini değiştirebilirsiniz.

Bu sayfada bir API anahtarı oluşturmayı, /profile endpoint'i ile anahtarı test etmeyi ve sık karşılaşılan hataları çözmeyi anlatıyoruz.

Başlamadan önce

API anahtarı oluşturabilmek için hesabınızın Yönetici veya Kurucu rolüne sahip olması gerekir. Diğer roller geliştirici ayarları sayfasına erişemez.

https://use.hipcall.com.tr/ adresinden panele giriş yapın.
Sol menüden Ayarlar > Geliştirici sayfasına gidin.
API sekmesini açın.
Yeni butonuna tıklayın.
Anahtara ne için kullandığınızı anlatan bir ad verin (örneğin CRM Entegrasyonu).
Son geçerlilik tarihi seçin. Süre 1 gün ile 3 yıl arasında olabilir; varsayılan değer 1 yıldır.
Oluştur butonuna tıklayın.

Hipcall, anahtarı oluşturduktan hemen sonra tam halini ekranda bir kez gösterir. Sayfadan ayrılmadan önce anahtarı bir şifre yöneticisine kopyalayın. Sonrasında panelde anahtarın maskelenmiş hali dışında bir şey göremezsiniz.

İlk isteğinizi gönderin

Anahtarı kod içine yazmak yerine bir çevre değişkeninde saklayın:

export HIPCALL_API_TOKEN="SFMyNTY.g2gDbQAAAC..."

API, standart Authorization: Bearer başlığını kullanır. Her şeyin çalıştığını görmek için /profile endpoint'ine GET isteği gönderin:

curl -sS -i \
  -H "Authorization: Bearer $HIPCALL_API_TOKEN" \
  https://use.hipcall.com.tr/api/v3/profile

Yanıtı okuma

Geçerli bir anahtar 200 OK döner. JSON gövdesinde anahtarın bağlı olduğu kullanıcı, atanmış telefon numaraları, varsayılan Caller ID ve hesap limitleri yer alır:

{
  "data": {
    "user": {
      "id": 4200,
      "owner": true,
      "suspended": false,
      "state": "available",
      "title": null,
      "email": "ahmet@example.com",
      "locale": "tr_TR",
      "timezone": "Europe/Istanbul",
      "created_at": "2026-07-21T10:55:30Z",
      "full_name": "Ahmet Y.",
      "numbers": [
        {
          "id": 938,
          "name": "Müşteri Hizmetleri",
          "number": "+90850XXXXXXX",
          "country": "TR"
        }
      ],
      "default_number": {
        "id": 938,
        "name": "Müşteri Hizmetleri",
        "number": "+90850XXXXXXX",
        "country": "TR"
      },
      "first_name": "Ahmet",
      "last_name": "Y.",
      "phone_prefix": "TR"
    },
    "account": {
      "locale": "tr_TR",
      "timezone": "Europe/Istanbul",
      "contact_center": {
        "b2b": true
      },
      "limits": {
        "max_channel": 5
      }
    },
    "roles": []
  }
}

Yanıt başlıklarında hız sınırı sayaçları da gelir. Varsayılan limit dakikada 60 istektir.

Hata aldığınızda

API kimliğinizi doğrulayamazsa 401 Unauthorized döner. Hata mesajı nedenini söyler.

Authorization Başlık eksik

Authorization başlığını eklemeyi unutursanız şu yanıtı alırsınız:

{
  "errors": {
    "detail": "Authentication required. Provide either OAuth Bearer token or API token."
  }
}

İsteğinizde Authorization: Bearer <token> başlığının olduğundan ve çevre değişkeninin tanımlı olduğundan emin olun.

Anahtar geçersiz veya süresi dolmuş

Anahtar silinmiş ya da süresi geçmişse:

{
  "errors": {
    "detail": "Not authorized. Check your API token is valid and not expired."
  }
}

Panelde Ayarlar > Geliştirici > API sayfasından anahtarın durumunu kontrol edin. Süresi dolmuşsa veya güvenliğinden şüphe ediyorsanız eski anahtarı silip yenisini oluşturun.

Anahtarınızı güvende tutun

API anahtarlarını Git reposuna eklemeyin, frontend koduna yazmayın.
Üretim ortamında anahtarları çevre değişkenleri, Docker Secrets veya bir bulut anahtar kasası ile iletin.
Bir anahtarın sızdığını düşünüyorsanız panelden silin. Silinen anahtar anında geçersiz olur.

Parametre listesi

Profil endpoint'i sorgu parametresi veya istek gövdesi almaz:

Parametre	Konum	Tip	Zorunlu	Açıklama
`Authorization`	Header	string	Evet	`Bearer <API_TOKEN>` biçiminde kimlik doğrulama anahtarı.

Sonraki adımlar

Diğer endpoint'leri denemek için Hipcall API Referansı sayfasına bakın.
Çağrı kayıtlarını listeleme ve filtreleme adımlarına geçin.
Sorularınızı Hipcall Topluluk forumunda paylaşın.