API ključevi
API ključevi glavna su metoda autentifikacije prema Brevo API-ju. Nude jednostavan i siguran način programskog pristupa vašem računu.
Što su API ključevi?
API ključevi jedinstveni su identifikatori koji autentificiraju vašu aplikaciju pri slanju zahtjeva Brevo API-ju. Svaki ključ niz je od 64 znaka koji služi i kao identifikator i kao lozinka.
Example API key: xkeysib-a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456-Ab1Cd2Ef3Gh4Generiranje API ključeva
Vodič korak po korak
- Prijavite se u Brevo: otvorite svoju Brevo nadzornu ploču
- Idite na postavke: kliknite na svoj profil → Settings
- Otvorite API ključeve: odaberite „API Keys“ u lijevom izborniku
- Stvorite novi ključ: kliknite „Generate a New API Key“
- Imenujte ključ: dajte mu opisno ime (npr. „Production App“, „Development Testing“)
- Postavite dopuštenja: odaberite odgovarajuću razinu pristupa
- Generirajte: kliknite „Generate“ i odmah kopirajte ključ
Konvencije imenovanja API ključeva
Koristite opisna imena koja vam pomažu prepoznati svrhu ključa:
production-web-appstaging-environmentmobile-app-ioswebhook-listenerdata-sync-service
Vrste API ključeva i dopuštenja
Ključevi s punim pristupom
Permissions: All API endpointsUse cases: Complete application integrationRisk level: High - protect carefullyKljučevi samo za čitanje
Permissions: GET requests onlyUse cases: Analytics, reporting, dashboardsRisk level: Low - limited accessKljučevi samo za slanje
Permissions: Transactional email sendingUse cases: Application notifications, receiptsRisk level: Medium - can send emailsKljučevi za upravljanje kontaktima
Permissions: Contact CRUD operationsUse cases: CRM integrations, form submissionsRisk level: Medium - data modificationKorištenje API ključeva
Autentifikacija zaglavljem
Uključite svoj API ključ u zaglavlje api-key:
GET /v3/account HTTP/1.1Host: api.brevo.comAccept: application/jsonContent-Type: application/jsonapi-key: YOUR_API_KEYPrimjeri koda
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 requestapiInstance.getAccount() .then(data => console.log('Account info:', data)) .catch(error => console.error('Error:', error));Python
import sib_api_v3_sdkfrom sib_api_v3_sdk.rest import ApiException
# Configure API keyconfiguration = sib_api_v3_sdk.Configuration()configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Create API instanceapi_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
<?phprequire_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 keySibApiV3Sdk.configure do |config| config.api_key['api-key'] = 'YOUR_API_KEY'end
# Create API instanceapi_instance = SibApiV3Sdk::AccountApi.new
begin # Get account info result = api_instance.get_account puts resultrescue SibApiV3Sdk::ApiError => e puts "Exception when calling AccountApi->get_account: #{e}"endSigurnost API ključeva
Sigurna pohrana
Varijable okruženja (preporučeno)
# .env fileBREVO_API_KEY=xkeysib-your-api-key-here
# Usage in codeconst apiKey = process.env.BREVO_API_KEY;Upravitelji tajni u oblaku
- AWS Secrets Manager
- Google Secret Manager
- Azure Key Vault
- HashiCorp Vault
Najbolje sigurnosne prakse
-
Nikada ne kodirajte ključeve tvrdo
// ❌ Bad - hardcodedconst apiKey = "xkeysib-a1b2c3d4...";// ✅ Good - environment variableconst apiKey = process.env.BREVO_API_KEY; -
Koristite različite ključeve po okruženju
Production: BREVO_API_KEY_PRODStaging: BREVO_API_KEY_STAGINGDevelopment: BREVO_API_KEY_DEV -
Redovito mijenjajte ključeve
- Postavite podsjetnike u kalendaru za tromjesečnu zamjenu
- Koristite alate za automatizaciju zamjene ključeva
- Pripremite plan povratka na prethodno stanje
-
Nadzirite korištenje ključeva
- Postavite upozorenja za neuobičajenu aktivnost
- Mjesečno pregledavajte zapise o korištenju ključeva
- Pratite geografske obrasce pristupa
Upravljanje ključevima
Nadzor aktivnih ključeva
Nadzirite svoje aktivne ključeve na nadzornoj ploči:
Key Name: production-web-appCreated: 2024-01-15Last Used: 2024-01-20 14:30 UTCRequests Today: 1,247Status: ActivePostupak zamjene ključa
- Generirajte novi ključ: stvorite zamjenski ključ
- Ažurirajte konfiguraciju: postavite izdanje s novim ključem
- Nadzirite: provjerite radi li novi ključ ispravno
- Prijelazno razdoblje: zadržite stari ključ aktivnim 24-48 sati
- Opozovite stari ključ: izbrišite prethodni ključ
Hitan opoziv ključa
Ako je ključ kompromitiran:
- Trenutačni opoziv: izbrišite ključ s nadzorne ploče
- Generirajte zamjenu: odmah stvorite novi ključ
- Ažurirajte aplikacije: što prije postavite izdanje s novim ključem
- Nadzirite aktivnost: provjerite ima li neovlaštenog korištenja
- Izvještaj o incidentu: dokumentirajte sigurnosni incident
Ograničenja brzine i API ključevi
Svaki API ključ ima vlastita ograničenja brzine:
- Besplatni plan: 300 zahtjeva na dan
- Starter plan: 20.000 zahtjeva na dan
- Business plan: 50.000 zahtjeva na dan
- Enterprise plan: prilagođena ograničenja
Zaglavlja s ograničenjem brzine
HTTP/1.1 200 OKX-RateLimit-Limit: 1000X-RateLimit-Remaining: 999X-RateLimit-Reset: 1640995200Rukovanje ograničenjima brzine
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; }}Rješavanje problema s API ključevima
Česte poruke o pogreškama
Neispravan API ključ (401)
{ "code": "unauthorized", "message": "Invalid API key provided"}Nedostatna dopuštenja (403)
{ "code": "permission_denied", "message": "API key does not have required permissions"}Prekoračeno ograničenje brzine (429)
{ "code": "too_many_requests", "message": "Rate limit exceeded for API key"}Kontrolni popis za otklanjanje problema
- Ključ je ispravno oblikovan (64 znaka)
- Nema dodatnih razmaka ni skrivenih znakova
- Ključ ima potrebna dopuštenja
- Ključ je aktivan (nije opozvan)
- Unutar ograničenja brzine
- Koristi se ispravna krajnja točka API-ja
- Zaglavlja su ispravno oblikovana
Sljedeći koraci
- Saznajte više o OAuth 2.0
- Upoznajte JWT tokene
- Istražite ograničenja brzine
- Isprobajte SDK-ove