Kimlik Doğrulama

Genel Bakış

API, yalnızca yetkili kullanıcıların kaynaklara erişebilmesini sağlamak için kimlik doğrulaması gerektirir. Kimlik doğrulama süreci, bir API anahtarı edinmeyi ve bunu istek başlıklarında kullanmayı içerir.

Terimler

API Anahtarı {apiKey}

• API Anahtarı: API'ye yapılan istekleri kimlik doğrulaması için kullanılan benzersiz bir tanımlayıcıdır. İstek başlıklarında iletilen bir dizedir.

Proje ID'si {projectId}

• Proje ID'si: API içinde bir projeye ait benzersiz bir tanımlayıcıdır. İsteğin bağlamını belirtmek için kullanılır.

API anahtarı belirli bir projeye bağlıdır. İstek yaparken, proje ID'sini istek URL'sinde belirtmeniz gerekir. Proje ID'si, API içindeki projeniz için benzersiz bir tanımlayıcıdır. Bir API anahtarı birden fazla projede kullanılabilir, ancak her projenin kendine ait benzersiz bir proje ID'si vardır.

Kimlik Doğrulama Süreci

1. API Anahtarı Edinin: Bir API anahtarı almak için destek ekibimizle iletişime geçmeniz gerekir. API anahtarı, isteklerinizi kimlik doğrulamak için kullanılan benzersiz bir tanımlayıcıdır.

   • Destek ile İletişime Geçin: API anahtarınızı talep etmek için e-posta veya destek portalı üzerinden destek ekibimize ulaşın.
   • Gerekli Bilgileri Sağlayın: Hesabınız ve API'nin kullanım amacı hakkında bilgi vermeniz gerekebilir.
   • API Anahtarınızı ve Proje ID'nizi Alın: Talebiniz onaylandığında, API anahtarınızı ve ilgili proje ID'sini alırsınız. Bu bilgileri güvenli bir şekilde saklayın; tüm API isteklerinde gerekli olacaktır.

2. API Anahtarını İsteklere Ekleyin: API anahtarını istek başlıklarına şu şekilde ekleyin:

   Headers:
     x-api-key: YOUR_API_KEY
     Content-Type: application/json

3. API İstekleri Yapın: Tüm isteklerinizde API anahtarını kullanarak kaynaklara erişim için kimlik doğrulaması ve yetkilendirme sağlayın.

4. Kimlik Doğrulama Hatalarını Yönetin: API anahtarı eksik veya geçersizse, 401 Unauthorized yanıtı alırsınız. API anahtarınızın doğru olduğundan ve istenen kaynağa erişim için gerekli izinlere sahip olduğundan emin olun.

5. API Anahtarını Yenileyin: API anahtarınızın güvenliğinin tehlikeye girdiğinden şüpheleniyorsanız, uygulama ayarlarından yeni bir anahtar oluşturabilirsiniz. İsteklerinizde yeni API anahtarını kullandığınızdan emin olun.

6. Rate Limiting: Endpointler, API anahtarına göre rate limit uygular. Sınırı aşarsanız, 429 Too Many Requests yanıtı alırsınız. Kullanımınızı gözlemleyin ve isteklerinizi buna göre ayarlayın.

7. En İyi Uygulamalar:

   • API anahtarınızı güvenli tutun ve herkese açık depolarda veya istemci tarafı kodda paylaşmayın.
   • Geliştirme ve üretim ortamlarında API anahtarınızı ortam değişkenlerinde saklayın.
   • Güvenliği artırmak için API anahtarlarınızı düzenli olarak gözden geçirin ve döndürün.

8. Destek ile İletişime Geçin: Kimlik doğrulama ile ilgili herhangi bir sorun yaşarsanız veya API anahtarı hakkında sorularınız olursa, destek ekibimizle iletişime geçin.

Örnek İstek

curl -X GET "https://staging.saharobotik.com/api/v2/client/{projectId}/delivery/targets" \
  -H "x-api-key: {apiKey}"
  -H "Content-Type: application/json"