Giriş

Marpany API dokümantasyonuna hoş geldiniz. API'miz, reklam kampanyalarınızı programatik olarak yönetmenize, performans verilerini analiz etmenize ve mevcut sistemlerinizle entegre olmanıza olanak tanır.

Marpany API, REST mimarisine göre organize edilmiştir. API'miz tahmin edilebilir kaynak odaklı URL'lere sahiptir, JSON ile kodlanmış istek gövdeleri kabul eder, JSON ile kodlanmış yanıtlar döndürür ve standart HTTP yanıt kodları, kimlik doğrulama ve fiilleri kullanır.

Temel URL: https://api.marpany.com/v1

Kimlik Doğrulama

Marpany API, istekleri doğrulamak için API anahtarları kullanır. API anahtarlarınızı Developer Portal'da görüntüleyebilir ve yönetebilirsiniz. Developer Portal.

API Anahtarı Kimlik Doğrulama

API anahtarınızı istek başlıklarına ekleyin:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Güvenlik Uyarısı: API anahtarlarınızı güvende tutun. Bunları herkese açık alanlarda paylaşmayın.

Hız Sınırlama

API istekleri katmana göre sınırlandırılmıştır. Hız sınırları şu şekildedir:

Katman Dakika Başına İstek Günlük Limit
ücretsiz 60 1,000
temel 300 10,000
profesyonel 1,000 100,000
kurumsal Sınırsız Sınırsız

Hız Sınırı Başlıkları

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Hata Yönetimi

Marpany, bir API isteğinin başarısını veya başarısızlığını belirtmek için geleneksel HTTP yanıt kodlarını kullanır.

Kod Anlamı
200 Başarılı
400 Hatalı İstek - Geçersiz parametreler
401 Yetkisiz - Geçersiz API anahtarı
403 Yasak - Yetersiz izinler
404 Bulunamadı - Kaynak mevcut değil
429 Çok Fazla İstek - Hız sınırı aşıldı
500 Dahili Sunucu Hatası

Hata Yanıt Örneği

{
  "error": {
    "code": "invalid_request",
    "message": "The campaign_id field is required.",
    "param": "campaign_id"
  }
}

Kampanyalar

Tüm Kampanyaları Listele

GET /campaigns

Tüm reklam kampanyalarınızın bir listesini alır.

Parametreler

Parametre Tip Açıklama
limit integer Döndürülecek kampanya sayısı (varsayılan: 50, maksimum: 100)
offset integer Atlanacak kampanya sayısı (varsayılan: 0)
status string Duruma göre filtrele: active, paused, ended

Yanıt Örneği

{
  "data": [
    {
      "id": "camp_123abc",
      "name": "Summer Sale 2025",
      "status": "active",
      "budget": 5000.00,
      "spent": 3250.50,
      "created_at": "2025-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 145,
    "limit": 50,
    "offset": 0
  }
}

Create Campaign

POST /campaigns

Creates a new advertising campaign.

Request Body

{
  "name": "My Campaign",
  "budget": 1000.00,
  "platform": "meta",
  "objective": "conversions",
  "start_date": "2025-01-20",
  "end_date": "2025-02-20"
}

Products

Sync Products

POST /products/sync

Synchronizes your product catalog with the advertising platforms.

Request Body

{
  "platform": "meta",
  "catalog_id": "catalog_123"
}

Analytics

Get Campaign Analytics

GET /analytics/campaigns/{campaign_id}

Retrieves detailed analytics for a specific campaign.

Parameters

Parameter Type Description
start_date date Start date (YYYY-MM-DD)
end_date date End date (YYYY-MM-DD)
metrics array Metrics to include: impressions, clicks, conversions

Webhooks

Webhooks allow you to receive real-time notifications about events in your account.

Configure Webhooks

POST /webhooks

Request Body

{
  "url": "https://your-domain.com/webhook",
  "events": ["campaign.created", "campaign.ended"],
  "secret": "your_webhook_secret"
}

Kod Örnekleri

PHP

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.marpany.com/v1/campaigns');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_KEY',
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
$campaigns = json_decode($response, true);
curl_close($ch);

JavaScript (Node.js)

const axios = require('axios');

const response = await axios.get('https://api.marpany.com/v1/campaigns', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

console.log(response.data);

Python

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}

response = requests.get('https://api.marpany.com/v1/campaigns', headers=headers)
campaigns = response.json()
print(campaigns)

Destek

API ile ilgili yardıma ihtiyacınız varsa veya sorularınız varsa: