 Nachrichten über eine Schnittstelle veröffentlichen (API) |
API
Das application programming interface (API) ermöglicht Dritten über eine Schnittstelle Nachrichten über ein Drittprogramm direkt an presse-kostenlos.de zu übergeben. Hier erfahren Sie welche Parameter unsere API zur Verfügung stellt.
Funktionsweise
Die Übertragung und das Hinzufügen einer neuen Nachricht erfolgt über die API in zwei Schritten:
1. Neue Nachricht (Daten) übertragen und zugewiesene SID auslesen.
2. Neue Nachricht mit der zugewiesenen SID temporär speichern.
Hinweis:
Der automatische Bilderdienst (GetPressImage) wird aktiviert, wenn ein Bild (Image) zur Nachricht hinzugefügt werden soll.
Aufruf der API
URL:
http://www.presse-kostenlos.de/press.exe
Methode:
Post (methPost)
Neue Nachricht übertragen
Parameter:
| add |
value: Boolean |
"false" / "true"
nicht 0 / 1 |
Default: False
Wenn true wird angenommen es soll eine Nachricht übertragen werden, ansonsten HTTP 301. |
Pflichtfeld |
| firma |
value: Array of char |
max chars 50 |
|
Optional |
| vorname |
value: Array of char |
max chars 50 |
|
Pflichtfeld |
| name |
value: Array of char |
max chars 50 |
|
Pflichtfeld |
| strasse |
value: Array of char |
max chars 50 |
|
Optional |
| plz |
value: Array of char |
max chars 5 |
|
Optional |
| wohnort |
value: Array of char |
max chars 50 |
|
Optional |
| |
|
|
|
|
| telefon |
value: Array of char |
max chars 20 |
|
Optional |
| telefax |
value: Array of char |
max chars 20 |
|
Optional |
| |
|
|
|
|
| ansprechpartner |
value: Array of char |
max chars 30 |
|
Optional |
| |
|
|
|
|
| email |
value: Array of char |
max chars 50 |
|
Pflichtfeld |
| homepage |
value: Array of char |
max chars 50 |
|
Optional |
| |
|
|
|
|
| prkz |
value: Array of char |
max chars 10 |
chars: A-Z, a-z, 0-9 |
Optional |
| prkzpass |
value: Array of char |
max chars 20 |
chars: A-Z, a-z, 0-9 |
Optional |
| |
|
|
|
|
| titel |
value: Array of char |
max chars 120 |
Wörter <= 23 Zeichen |
Pflichtfeld |
| kategorie |
value: Byte |
1 - 45 |
Siehe Kat-Index
|
Pflichtfeld |
| content |
value: Array of char |
max chars 9580 |
Fließtext:
Min. 200 Wörter
Max. 4 Links auf URL
|
Pflichtfeld |
| |
|
|
|
|
| bild |
value: Array of char |
max chars 250 |
URL zeigt auf Image: GIF, JPG, JPEG |
Optional |
| |
|
|
|
|
| nodelpress |
value: Byte |
0 / 1 |
0 = aut. löschen
1 = nicht aut. löschen
|
Pflichtfeld |
| expire_date |
value: Date (DE) |
Date <= Now + 12 weeks |
TT.MM.JJJJ |
Optional |
| timeout |
value: Byte |
1 - 12 |
Now + x weeks |
Wenn nodelpress = 0 dann Pflichtfeld. |
| |
|
|
|
|
| rules |
value: Boolean |
"false" / "true"
nicht 0 / 1 |
Regeln zugestimmt! |
Pflichtfeld |
| |
|
|
|
|
| doAPI |
value: Boolean |
"false" / "true"
nicht 0 / 1 |
Default: False
Wenn true wird nach Aufruf der API im XML-Format
das Ergebnis zurück gegeben. |
Optional |
Beispiel:
http://www.presse-kostenlos.de/press.exe?add=true&firma=MyCompany&vorname=Udo
&name=Muster&email=info@emailadresse.cap&titel=Das ist ein Test&kategorie=1&content=Hier steht der Nachrichtentext...&nodelpress=1&rules=true&doAPI=true
Results (wenn doAPI = true!)
Wenn keine Fehler bei der Parameterübergabe aufgetreten sind und die neue Nachricht hinzugefügt und temporär gespeichert werden kann:
<?xml version="1.0" encoding="windows-1252"?>
<api>
<results>
<result>OK</result>
<resultnr>0</resultnr>
<resultstr>Done!</resultstr>
<SID>Double</SID>
</results>
</api>
Wenn ein Fehler bei der Parameterübergabe aufgetreten ist:
<?xml version="1.0" encoding="windows-1252"?>
<api>
<results>
<result>Error</result>
<resultnr>Fehlernummer</resultnr>
<resultstr>Fehlermeldung, String im HTML Format</resultstr>
</results>
</api>
Übersicht der Fehlernummern und Fehlermeldungen anzeigen.
Neue Nachricht hinzufügen und temporär speichern
Bitte beachten Sie, dass nach einer erfolgreichen Übertragung einer neuen Pressemtteilung diese noch nicht hinzugefügt und temporär gespeichert wurde! Nachrichten müssen nach der erfolgreichen Übertragung an uns auch gespeichert werden. Diese verbleiben dann maximal 24 Stunden temporär in einem Speicher und warten auf die endgültige Aktivierung durch den User (über Email) oder uns. Nach Ablauf von 24 Stunden werden die nicht durch den User oder uns aktivierten Pessemitteilungen aus dem temporären Speicher automatisch gelöscht.
Aus diesem Grund erhalten Sie auch über unsere API eine "SAVE ID" (SID).
Nur über die SID können Sie Nachrichten auf unseren Servern hinzufügen und temporär speichern.
Die SID erhalten Sie nach der Übertragung der Nachricht im XML-Format (siehe oben):
[...]
<SID>Double</SID>
Die SID könnte zum Beispiel so aussehen: 40063814841331
[...]
Parameter:
| save |
value: Boolean |
"false" / "true"
nicht 0 / 1 |
true um die Presse-mitteilung zu speichern, ansonsten HTTP 301. |
Pflichtfeld |
| SID |
value: Double |
zugewiesene SID |
siehe oben |
Pflichtfeld |
| doAPI |
value: Boolean |
"false" / "true"
nicht 0 / 1 |
Default: False
Wenn true wird nach Aufruf der API im XML-Format
das Ergebnis zurück gegeben. |
Optional |
Results (wenn doAPI = true!)
Wenn keine Fehler bei der Parameterübergabe aufgetreten sind und die neue Nachricht temporär gespeichert ist. An den Sender wurde eine Email mit einem Aktivierungs-Link (URL) für die Nachricht gesendet, sofern ein gültiges und freigeschaltetes Pressekürzel übergeben wurde. Mit diesem Link kann der Empfänger die Nachricht umgehend selbst aktivieren und für das Internet sichtbar machen. Ansonsten erfolgt nach Prüfung der Nachricht die Aktivierung der Nachricht durch einen Administrator bei presse-kostenlos.de (Spam-Schutz). Wurde bei dieser durch den Administrator aktivierten Nachricht zum ersten Mal ein Pressekürzel verwendet, wird dieses gleichzeitig und automatisch freigeschaltet und kann zukünftig für weitere Nachrichten genutzt werden.
<?xml version="1.0" encoding="windows-1252"?>
<api>
<results>
<result>OK</result>
<resultnr>0</resultnr>
<resultstr>Done!</resultstr>
</results>
</api>
Wenn ein Fehler bei der Parameterübergabe aufgetreten ist:
<?xml version="1.0" encoding="windows-1252"?>
<api>
<results>
<result>Error</result>
<resultnr>Fehlernummer</resultnr>
<resultstr>Fehlermeldung, String im HTML Format</resultstr>
</results>
</api>
Übersicht der Fehlernummern und Fehlermeldungen anzeigen.
|
