Artikel über die API erstellen

Überblick

Mit der Article API können Sie programmatisch Artikel erstellen. Diese Dokumentation erklärt alle erforderlichen und optionalen Felder sowie deren Validierungsregeln.

API-Endpunkt

POST /api/articles

Authentifizierung: Bearer Token erforderlich

Feld-Referenz

Pflichtfelder

1. Title (Titel)

"title": "Immobilienmarkt 2024: Diese Trends sollten Sie kennen"

Validierung:

• Minimum: 4 Wörter
• Maximum: 250 Zeichen
• Typ: String

❌ Ungültig: "Immobilienmarkt 2024" (nur 2 Wörter) ✅ Gültig: "Immobilienmarkt 2024: Die wichtigsten Trends"

2. Content (Inhalt)

Der Inhalt muss als HTML formatiert sein. Nur bestimmte Tags sind erlaubt:

"content": "<h2>Einleitung</h2><p>Der Immobilienmarkt befindet sich im Wandel...</p>"

Validierung:

• Minimum: 800 Zeichen
• Maximum: 12.000 Zeichen
• Erlaubte HTML-Tags: h2, h3, p, ul, li, cite, strong
• Verboten: style und class Attribute

Beispiel gültiger Content:

<h2>Marktentwicklung 2024</h2>
<p>Der Immobilienmarkt zeigt <strong>positive Signale</strong> für Investoren. Besonders in urbanen Gebieten steigt die Nachfrage kontinuierlich.</p>

<h3>Wichtigste Faktoren</h3>
<ul>
  <li>Zinsentwicklung der Europäischen Zentralbank</li>
  <li>Demografische Veränderungen</li>
  <li>Baulandpreise in Ballungsräumen</li>
</ul>

<p><cite>Quelle: Immobilienmarkt-Studie 2024</cite></p>

3. Categories (Kategorien)

Array mit 1-3 Kategorie-IDs:

"categories": [1, 3, 5]

Validierung:

• Minimum: 1 Kategorie
• Maximum: 3 Kategorien
• Alle IDs müssen existieren

Wie Sie Kategorie-IDs abrufen, erfahren Sie in der Dokumentation Kategorie-IDs abrufen.

4. Images (Bilder)

Array mit 1-5 Bild-Objekten:

"images": [
  {
    "url": "https://example.com/images/immobilien-markt.jpg",
    "alt": "Moderne Wohngebäude in der Innenstadt"
  },
  {
    "url": "https://example.com/images/statistik.jpg",
    "alt": "Grafik zur Marktentwicklung im Jahr 2024"
  }
]

Validierung URL:

• Muss eine gültige URL sein
• Muss erreichbar sein (active_url Validierung)
• Maximum: 2048 Zeichen

Validierung Alt-Text:

• Minimum: 3 Wörter
• Maximum: 250 Zeichen

Optionale Felder

Excerpt (Auszug)

Kurze Zusammenfassung des Artikels:

"excerpt": "Ein Überblick über die wichtigsten Entwicklungen im Immobilienmarkt 2024"

Validierung:

• Minimum: 5 Wörter (wenn angegeben)
• Maximum: 500 Zeichen
• Typ: String oder null

Publish At (Veröffentlichungsdatum)

ISO 8601 formatiertes Datum:

"publish_at": "2024-03-15T14:30:00Z"

Validierung:

• ISO 8601 Format
• Typ: String oder null
• Wenn nicht angegeben, wird der Artikel nicht automatisch veröffentlicht

Beispiele gültiger Formate:

"2024-03-15T14:30:00Z"
"2024-03-15T14:30:00+01:00"
"2024-03-15T14:30:00.000Z"

Vollständiges Beispiel

cURL

curl -X POST https://ihre-domain.de/api/articles \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "title": "Immobilienmarkt 2024: Die wichtigsten Trends und Entwicklungen",
    "content": "<h2>Einleitung</h2><p>Der Immobilienmarkt in Deutschland zeigt sich auch 2024 weiterhin dynamisch. Mit über 800 Zeichen an relevantem Content bieten wir Ihnen hier einen umfassenden Überblick über die aktuellen Entwicklungen. Die Zinspolitik der EZB spielt dabei eine zentrale Rolle für Investoren und Käufer. Besonders in den Metropolregionen München, Frankfurt und Hamburg beobachten wir interessante Trends, die wir im Folgenden detailliert analysieren werden. Die Preisentwicklung zeigt regionale Unterschiede, die für Anlageentscheidungen relevant sind. Demografische Faktoren beeinflussen zusätzlich die Nachfrage nach Wohnraum in verschiedenen Segmenten des Marktes.</p><h3>Marktanalyse</h3><ul><li>Zinsentwicklung und deren Auswirkungen</li><li>Regionale Preisentwicklung</li><li>Nachfragetrends nach Objekttypen</li></ul><p><strong>Fazit:</strong> Der Markt bietet weiterhin Chancen für Investoren.</p>",
    "excerpt": "Ein umfassender Überblick über die wichtigsten Entwicklungen im deutschen Immobilienmarkt 2024",
    "publish_at": "2024-03-15T10:00:00Z",
    "categories": [1, 2],
    "images": [
      {
        "url": "https://example.com/images/immobilien-2024.jpg",
        "alt": "Moderne Wohngebäude im Stadtgebiet München"
      },
      {
        "url": "https://example.com/images/markt-statistik.jpg",
        "alt": "Grafische Darstellung der Immobilienpreisentwicklung Deutschland"
      }
    ]
  }'

JavaScript (fetch)

const articleData = {
  title: "Immobilienmarkt 2024: Die wichtigsten Trends und Entwicklungen",
  content: "<h2>Einleitung</h2><p>Der Immobilienmarkt...</p>",
  excerpt: "Ein umfassender Überblick...",
  publish_at: "2024-03-15T10:00:00Z",
  categories: [1, 2],
  images: [
    {
      url: "https://example.com/images/immobilien-2024.jpg",
      alt: "Moderne Wohngebäude im Stadtgebiet München"
    }
  ]
};

fetch('https://ihre-domain.de/api/articles', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer ' + apiToken,
    'Content-Type': 'application/json',
    'Accept': 'application/json'
  },
  body: JSON.stringify(articleData)
})
.then(response => response.json())
.then(data => {
  console.log('Artikel erstellt:', data);
})
.catch(error => {
  console.error('Fehler:', error);
});

PHP

$articleData = [
    'title' => 'Immobilienmarkt 2024: Die wichtigsten Trends und Entwicklungen',
    'content' => '<h2>Einleitung</h2><p>Der Immobilienmarkt...</p>',
    'excerpt' => 'Ein umfassender Überblick...',
    'publish_at' => '2024-03-15T10:00:00Z',
    'categories' => [1, 2],
    'images' => [
        [
            'url' => 'https://example.com/images/immobilien-2024.jpg',
            'alt' => 'Moderne Wohngebäude im Stadtgebiet München'
        ]
    ]
];

$ch = curl_init('https://ihre-domain.de/api/articles');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer ' . $apiToken,
    'Content-Type: application/json',
    'Accept: application/json'
]);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($articleData));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode === 201) {
    $article = json_decode($response, true);
    echo "Artikel erstellt mit ID: " . $article['data']['id'];
} else {
    echo "Fehler: " . $response;
}

Erfolgreiche Antwort (201 Created)

{
  "data": {
    "id": 42,
    "title": "Immobilienmarkt 2024: Die wichtigsten Trends und Entwicklungen",
    "content": "<h2>Einleitung</h2>...",
    "excerpt": "Ein umfassender Überblick...",
    "link": "https://ihre-domain.de/artikel/immobilienmarkt-2024-die-wichtigsten-trends",
    "publish_at": "2024-03-15T10:00:00.000000Z",
    "created_at": "2024-03-10T08:15:00.000000Z",
    "updated_at": "2024-03-10T08:15:00.000000Z",
    "author": {
      "id": 1,
      "name": "Max Mustermann"
    },
    "categories": [
      {
        "id": 1,
        "name": "Immobilienmarkt",
        "description": "Aktuelle Entwicklungen..."
      },
      {
        "id": 2,
        "name": "Finanzierung",
        "description": "Themen rund um..."
      }
    ],
    "images": [
      {
        "id": 123,
        "alt": "Moderne Wohngebäude im Stadtgebiet München",
        "url": "https://ihre-domain.de/storage/media/123/immobilien-2024.jpg"
      }
    ]
  },
  "message": "Article created successfully"
}

Fehlerbehandlung

Validierungsfehler (422 Unprocessable Entity)

{
  "message": "Der Titel muss mindestens 4 Wörter enthalten. (and 2 more errors)",
  "errors": {
    "title": [
      "Der Titel muss mindestens 4 Wörter enthalten."
    ],
    "content": [
      "Der Inhalt muss mindestens 800 Zeichen enthalten."
    ],
    "categories": [
      "Es muss mindestens eine Kategorie ausgewählt werden."
    ]
  }
}

Authentifizierungsfehler (401 Unauthorized)

{
  "message": "Unauthenticated."
}

Häufige Fehler und Lösungen

Autor-Zuordnung

Standard: Der authentifizierte Benutzer wird als Autor gesetzt.

Für Unternehmens-Artikel: Siehe Artikel für Unternehmen veröffentlichen.

Nächste Schritte

• Artikel für Unternehmen veröffentlichen
• API-Token Verwaltung
• Kategorie-IDs abrufen