Erken erişim talep edin

Adınızı ve e-posta adresinizi veya telefon numaranızı paylaşın. Tajo erişim ayrıntıları için sizinle iletişime geçeceğiz.

Bu sayfada

API Anahtarları

API anahtarları, Brevo API ile kimlik doğrulamanın başlıca yöntemidir. Hesabınıza programatik olarak erişmenin basit ve güvenli bir yolunu sunarlar.

API anahtarı nedir?

API anahtarları, Brevo API’ye istek gönderirken uygulamanızın kimliğini doğrulayan benzersiz tanımlayıcılardır. Her anahtar, hem tanımlayıcı hem de parola işlevi gören 64 karakterlik bir dizedir.

Example API key: xkeysib-a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456-Ab1Cd2Ef3Gh4

API anahtarı oluşturma

Adım adım rehber

  1. Brevo’ya giriş yapın: Brevo yönetim panelinize erişin
  2. Ayarlara gidin: Profilinize tıklayın → Settings
  3. API Keys bölümüne geçin: Sol menüden “API Keys” seçeneğini seçin
  4. Yeni anahtar oluşturun: “Generate a New API Key” düğmesine tıklayın
  5. Anahtarınızı adlandırın: Açıklayıcı bir ad verin (örneğin “Production App”, “Development Testing”)
  6. İzinleri belirleyin: Uygun erişim düzeyini seçin
  7. Oluşturun: “Generate” düğmesine tıklayın ve anahtarı hemen kopyalayın

API anahtarı adlandırma kuralları

Anahtarın amacını tanımanıza yardımcı olacak açıklayıcı adlar kullanın:

  • production-web-app
  • staging-environment
  • mobile-app-ios
  • webhook-listener
  • data-sync-service

API anahtarı türleri ve izinleri

Tam erişim anahtarları 

Permissions: All API endpoints
Use cases: Complete application integration
Risk level: High - protect carefully

Salt okunur anahtarlar 

Permissions: GET requests only
Use cases: Analytics, reporting, dashboards
Risk level: Low - limited access

Yalnızca gönderim anahtarları 

Permissions: Transactional email sending
Use cases: Application notifications, receipts
Risk level: Medium - can send emails

Kişi yönetimi anahtarları 

Permissions: Contact CRUD operations
Use cases: CRM integrations, form submissions
Risk level: Medium - data modification

API anahtarlarını kullanma

Başlık ile kimlik doğrulama

API anahtarınızı api-key başlığına ekleyin:

GET /v3/account HTTP/1.1
Host: api.brevo.com
Accept: application/json
Content-Type: application/json
api-key: YOUR_API_KEY

Kod örnekleri

JavaScript/Node.js 

const brevo = require('@getbrevo/brevo');


const apiInstance = new brevo.AccountApi();
apiInstance.setApiKey(brevo.AccountApiApiKeys.apiKey, process.env.BREVO_API_KEY);


// Make authenticated request
apiInstance.getAccount()
  .then(data => console.log('Account info:', data))
  .catch(error => console.error('Error:', error));

Python 

import sib_api_v3_sdk
from sib_api_v3_sdk.rest import ApiException


# Configure API key
configuration = sib_api_v3_sdk.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'


# Create API instance
api_instance = sib_api_v3_sdk.AccountApi(sib_api_v3_sdk.ApiClient(configuration))


try:
    # Get account info
    api_response = api_instance.get_account()
    print(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->get_account: %s\n" % e)

PHP 

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');


// Create API instance
$apiInstance = new SendinBlue\Client\Api\AccountApi(
    new GuzzleHttp\Client(),
    $config
);


try {
    $result = $apiInstance->getAccount();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getAccount: ', $e->getMessage(), PHP_EOL;
}
?>

Ruby 

require 'sib-api-v3-sdk'


# Configure API key
SibApiV3Sdk.configure do |config|
  config.api_key['api-key'] = 'YOUR_API_KEY'
end


# Create API instance
api_instance = SibApiV3Sdk::AccountApi.new


begin
  # Get account info
  result = api_instance.get_account
  puts result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling AccountApi->get_account: #{e}"
end

API anahtarı güvenliği

Güvenli saklama

Ortam değişkenleri (önerilir)

Terminal window
# .env file
BREVO_API_KEY=xkeysib-your-api-key-here


# Usage in code
const apiKey = process.env.BREVO_API_KEY;

Bulut gizli anahtar yöneticileri

  • AWS Secrets Manager
  • Google Secret Manager
  • Azure Key Vault
  • HashiCorp Vault

Güvenlik için en iyi uygulamalar

  1. Anahtarları asla koda gömmeyin

    // ❌ Bad - hardcoded
    const apiKey = "xkeysib-a1b2c3d4...";
    

    // ✅ Good - environment variable
    const apiKey = process.env.BREVO_API_KEY;

  2. Her ortam için farklı anahtar kullanın

    Production:  BREVO_API_KEY_PROD
    Staging:     BREVO_API_KEY_STAGING
    Development: BREVO_API_KEY_DEV

  3. Anahtarları düzenli olarak değiştirin

    • Üç ayda bir yenileme için takvim hatırlatıcıları kurun
    • Anahtar yenileme için otomasyon araçları kullanın
    • Geri alma planınızı hazır tutun

  4. Anahtar kullanımını izleyin

    • Olağan dışı etkinlikler için uyarılar tanımlayın
    • Anahtar kullanım günlüklerini ayda bir inceleyin
    • Coğrafi erişim örüntülerini takip edin

Anahtar yönetimi

Aktif anahtar izleme

Aktif anahtarlarınızı yönetim panelinden izleyin:

Key Name: production-web-app
Created: 2024-01-15
Last Used: 2024-01-20 14:30 UTC
Requests Today: 1,247
Status: Active

Anahtar yenileme süreci

  1. Yeni anahtar oluşturun: Yerine geçecek anahtarı üretin
  2. Yapılandırmayı güncelleyin: Yeni anahtarla dağıtım yapın
  3. İzleyin: Yeni anahtarın doğru çalıştığından emin olun
  4. Geçiş süresi tanıyın: Eski anahtarı 24-48 saat boyunca aktif tutun
  5. Eski anahtarı iptal edin: Önceki anahtarı silin

Acil durumda anahtar iptali

Bir anahtar ele geçirilirse:

  1. Anında iptal edin: Anahtarı yönetim panelinden silin
  2. Yenisini oluşturun: Hemen yeni bir anahtar üretin
  3. Uygulamaları güncelleyin: En kısa sürede yeni anahtarla dağıtım yapın
  4. Etkinliği izleyin: Yetkisiz kullanım olup olmadığını kontrol edin
  5. Olay raporu hazırlayın: Güvenlik olayını belgeleyin

Hız limitleri ve API anahtarları

Her API anahtarının kendine ait hız limitleri vardır:

  • Ücretsiz plan: Günde 300 istek
  • Starter planı: Günde 20.000 istek
  • Business planı: Günde 50.000 istek
  • Enterprise planı: Özel limitler

Hız limiti başlıkları 

HTTP/1.1 200 OK
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Hız limitlerini yönetme 

async function makeApiCall() {
  try {
    const response = await fetch(url, { headers });


    if (response.status === 429) {
      const resetTime = response.headers.get('X-RateLimit-Reset');
      const waitTime = resetTime - Math.floor(Date.now() / 1000);


      console.log(`Rate limited. Waiting ${waitTime} seconds`);
      await new Promise(resolve => setTimeout(resolve, waitTime * 1000));


      // Retry the request
      return makeApiCall();
    }


    return response.json();
  } catch (error) {
    console.error('API call failed:', error);
    throw error;
  }
}

API anahtarı sorunlarını giderme

Yaygın hata mesajları

Geçersiz API anahtarı (401)

{
  "code": "unauthorized",
  "message": "Invalid API key provided"
}

Yetersiz izin (403)

{
  "code": "permission_denied",
  "message": "API key does not have required permissions"
}

Hız limiti aşıldı (429)

{
  "code": "too_many_requests",
  "message": "Rate limit exceeded for API key"
}

Hata ayıklama kontrol listesi

  • Anahtar doğru biçimde yazılmış (64 karakter)
  • Fazladan boşluk veya gizli karakter yok
  • Anahtar gerekli izinlere sahip
  • Anahtar aktif (iptal edilmemiş)
  • Hız limitleri aşılmamış
  • Doğru API uç noktası kullanılıyor
  • Başlıklar düzgün biçimlendirilmiş

Sonraki adımlar

Erken erişim talep edin

Adınızı ve e-posta adresinizi veya telefon numaranızı paylaşın. Tajo erişim ayrıntıları için sizinle iletişime geçeceğiz.

otomatik algılama
AI Asistan

Merhaba! Belgeler hakkında her şeyi sorabilirsiniz.