API Referansı

TechRam hizmetleriyle entegrasyon için örnekler, uç noktalar ve kod parçacıklarıyla tam API dokümantasyonu.

Yakında: Kapsamlı API dokümantasyonumuz şu anda geliştirilme aşamasındadır. Tam API'mizi en kısa sürede sağlayacağız. Güncellemeler için bizi takip edin!

1. Giriş

TechRam API, geliştiricilerin TechRam hizmetlerini uygulamalarına entegre etmelerine olanak tanır. RESTful API'miz, TechRam işlevselliğine programatik erişim sağlayarak özel entegrasyonlar oluşturmanıza ve iş akışlarını otomatikleştirmenize olanak tanır.

Bu dokümantasyon, TechRam API'sini kullanmak için kimlik doğrulama, uç noktalar, istek/yanıt formatları, hata yönetimi ve en iyi uygulamaları kapsayacaktır.

2. Kimlik Doğrulama

Tüm API istekleri API anahtarları kullanılarak kimlik doğrulama gerektirir. API anahtarınızı istek başlıklarına dahil edin:

Authorization: Bearer YOUR_API_KEY

API anahtarları TechRam hesap panonuzdan oluşturulabilir. API anahtarlarınızı güvende tutun ve bunları asla istemci tarafı kodunda veya genel depolarında açığa çıkarmayın.

3. Temel URL

Tüm API istekleri aşağıdaki temel URL'ye yapılmalıdır:

https://api.techramllc.com/v1

Tüm uç noktalar bu temel URL'ye göre görelidir. Örneğin, projeler uç noktasına erişmek için şunu kullanırsınız:

https://api.techramllc.com/v1/projects

4. API Uç Noktaları

TechRam API aşağıdaki uç noktaları sağlar:

Projeler

GET /projects

Hesabınızla ilişkili tüm projelerin listesini alın.

Proje Oluştur

POST /projects

Yeni bir proje oluşturun. Gerekli parametreler:

Parametre	Tür	Gerekli	Açıklama
name	string	Evet	Proje adı
description	string	Hayır	Proje açıklaması

5. İstek ve Yanıt Formatı

İstek Formatı

Tüm istekler aşağıdaki başlıkları içermelidir:

                    Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
                

İstek gövdeleri JSON kodlanmış olmalıdır.

Yanıt Formatı

Tüm yanıtlar JSON formatında döndürülür. Tipik bir başarı yanıtı:

                    {
  "success": true,
  "data": { ... },
  "message": "Operation successful"
}
                

6. Hata Yönetimi

API, başarı veya başarısızlığı belirtmek için standart HTTP durum kodlarını kullanır:

200 OK: İstek başarılı
201 Created: Kaynak başarıyla oluşturuldu
400 Bad Request: Geçersiz istek parametreleri
401 Unauthorized: Kimlik doğrulama gerekli veya geçersiz API anahtarı
404 Not Found: Kaynak bulunamadı
500 Server Error: Sunucu iç hatası

Hata yanıtları, neyin yanlış gittiğine dair ayrıntılar içeren bir mesaj alanı içerir.

7. Hız Sınırlama

Adil kullanımı sağlamak için API hız sınırlaması uygular:

Standart planlar: Dakikada 100 istek
Premium planlar: Dakikada 500 istek
Kurumsal planlar: Özel limitler

Hız limiti bilgileri yanıt başlıklarında yer alır. Limiti aşarsanız, 429 Çok Fazla İstek yanıtı alırsınız.

8. Kod Örnekleri

JavaScript Örneği

                    fetch('https://api.techramllc.com/v1/projects', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));
                

PHP Örneği

                    $ch = curl_init('https://api.techramllc.com/v1/projects');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'Authorization: Bearer YOUR_API_KEY',
  'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
                

9. Destek ve Kaynaklar

Ek yardım ve kaynaklar için:

Yardıma mı İhtiyacınız Var? Destek ekibimiz 7/24 hizmetinizdedir. API ile ilgili sorular için info@techramllc.com adresinden bizimle iletişime geçin.