Požiadajte o skorý prístup

Uveďte svoje krstné meno a e-mailovú adresu alebo telefónne číslo. Pošleme Vám podrobnosti o prístupe k platforme Tajo.

Na tejto stránke

API kľúče

API kľúče sú základnou metódou autentifikácie voči Brevo API. Poskytujú jednoduchý a bezpečný spôsob, ako programovo pristupovať k Vášmu účtu.

Čo sú API kľúče?

API kľúče sú jedinečné identifikátory, ktoré autentifikujú Vašu aplikáciu pri odosielaní požiadaviek na Brevo API. Každý kľúč je 64-znakový reťazec, ktorý slúži zároveň ako identifikátor aj ako heslo.

Example API key: xkeysib-a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456-Ab1Cd2Ef3Gh4

Generovanie API kľúčov

Postup krok za krokom

  1. Prihláste sa do Brevo: otvorte svoj dashboard Brevo
  2. Prejdite do nastavení: kliknite na svoj profil → Settings
  3. Otvorte API kľúče: v ľavej ponuke vyberte „API Keys“
  4. Vytvorte nový kľúč: kliknite na „Generate a New API Key“
  5. Pomenujte kľúč: dajte mu výstižný názov (napríklad „Production App“, „Development Testing“)
  6. Nastavte oprávnenia: zvoľte primeranú úroveň prístupu
  7. Vygenerujte: kliknite na „Generate“ a kľúč si okamžite skopírujte

Konvencie pre pomenovanie API kľúčov

Používajte výstižné názvy, ktoré Vám pomôžu rozpoznať účel kľúča:

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

Typy API kľúčov a oprávnenia

Kľúče s plným prístupom 

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

Kľúče len na čítanie 

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

Kľúče len na odosielanie 

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

Kľúče na správu kontaktov 

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

Používanie API kľúčov

Autentifikácia cez hlavičku

Svoj API kľúč vložte do hlavičky api-key:

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

Ukážky kódu

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

Bezpečnosť API kľúčov

Bezpečné uloženie

Premenné prostredia (odporúčané)

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


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

Cloudoví správcovia tajomstiev

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

Osvedčené bezpečnostné postupy

  1. Nikdy nezapisujte kľúče priamo do kódu

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

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

  2. Používajte iný kľúč pre každé prostredie

    Production:  BREVO_API_KEY_PROD
    Staging:     BREVO_API_KEY_STAGING
    Development: BREVO_API_KEY_DEV

  3. Pravidelne kľúče obmieňajte

    • Nastavte si v kalendári pripomienky na štvrťročnú výmenu
    • Na výmenu kľúčov použite automatizačné nástroje
    • Majte pripravený plán návratu k pôvodnému stavu

  4. Sledujte používanie kľúčov

    • Nastavte si upozornenia na neobvyklú aktivitu
    • Každý mesiac skontrolujte logy o používaní kľúčov
    • Sledujte, z akých geografických oblastí prichádzajú prístupy

Správa kľúčov

Sledovanie aktívnych kľúčov

Svoje aktívne kľúče sledujte v dashboarde:

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

Postup pri výmene kľúča

  1. Vygenerujte nový kľúč: vytvorte náhradný kľúč
  2. Aktualizujte konfiguráciu: nasaďte aplikáciu s novým kľúčom
  3. Sledujte: overte, že nový kľúč funguje správne
  4. Prechodné obdobie: ponechajte starý kľúč aktívny 24 až 48 hodín
  5. Zrušte starý kľúč: predchádzajúci kľúč vymažte

Núdzové zrušenie kľúča

Ak došlo k úniku kľúča:

  1. Okamžité zrušenie: vymažte kľúč z dashboardu
  2. Vytvorte náhradu: ihneď vygenerujte nový kľúč
  3. Aktualizujte aplikácie: čo najskôr nasaďte nový kľúč
  4. Sledujte aktivitu: skontrolujte, či nedošlo k neoprávnenému použitiu
  5. Správa o incidente: bezpečnostný incident zdokumentujte

Limity požiadaviek a API kľúče

Každý API kľúč má vlastné limity požiadaviek:

  • Plán Free: 300 požiadaviek za deň
  • Plán Starter: 20 000 požiadaviek za deň
  • Plán Business: 50 000 požiadaviek za deň
  • Plán Enterprise: individuálne limity

Hlavičky s limitmi požiadaviek 

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

Ošetrenie limitov požiadaviek 

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;
  }
}

Riešenie problémov s API kľúčmi

Časté chybové hlásenia

Neplatný API kľúč (401)

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

Nedostatočné oprávnenia (403)

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

Prekročený limit požiadaviek (429)

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

Kontrolný zoznam pri ladení

  • Kľúč má správny formát (64 znakov)
  • Žiadne medzery navyše ani skryté znaky
  • Kľúč má potrebné oprávnenia
  • Kľúč je aktívny (nebol zrušený)
  • Nie ste nad limitom požiadaviek
  • Používate správny endpoint API
  • Hlavičky sú správne naformátované

Ďalšie kroky

Požiadajte o skorý prístup

Uveďte svoje krstné meno a e-mailovú adresu alebo telefónne číslo. Pošleme Vám podrobnosti o prístupe k platforme Tajo.

automatické rozpoznanie
AI asistent

Ahoj! Opýtajte sa ma na dokumentáciu.