 Publish a promotion release via our interface (API) |
API
The application programming interface (API) allows third party to publish directly a promotion release through our interface. Find out the available parameters of our API.
Operation
The transmission and adding of a new promotion release via the API, made by two steps:
1. Transmitt the new promotion release (data) and read out the assigned SID.
2. Save the new promotion release with the assigned SID temporarily.
Note:
The automatic photo service (GetPressImage) will start if a picture (image) was added to a new promotion release.
Calling the API
URL:
http://www.werbeblaettchen.com/press.exe
Method:
Post (methPost)
Transfer a new promotion release
Parameters:
| add |
value: Boolean |
"false" / "true"
not 0 / 1
|
Default: False
If true, it is assumed that a new promotion release was transferred, otherwise answer HTTP 301. |
Required |
| firma |
value: Array of char |
max chars 50 |
(company) |
Optional |
| vorname |
value: Array of char |
max chars 50 |
(first name) |
Required |
| name |
value: Array of char |
max chars 50 |
(last name) |
Required |
| strasse |
value: Array of char |
max chars 50 |
(street) |
Optional |
| plz |
value: Array of char |
max chars 5 |
(postal code) |
Optional |
| wohnort |
value: Array of char |
max chars 50 |
(city) |
Optional |
| |
|
|
|
|
| telefon |
value: Array of char |
max chars 20 |
(phone) |
Optional |
| telefax |
value: Array of char |
max chars 20 |
(fax) |
Optional |
| |
|
|
|
|
| ansprechpartner |
value: Array of char |
max chars 30 |
(contact person) |
Optional |
| |
|
|
|
|
| email |
value: Array of char |
max chars 50 |
|
Required |
| 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 |
Words <= 23 chars |
Required |
| kategorie |
value: Byte |
1 - 45 |
See Cat-Index
|
Required |
| content |
value: Array of char |
max chars 9500 |
Floating text:
Min. 200 words
Max. 4 links to an URL |
Required |
| |
|
|
|
|
| bild |
value: Array of char |
max chars 250 |
URL shows to an image: GIF, JPG, JPEG |
Optional |
| |
|
|
|
|
| nodelpress |
value: Byte |
0 / 1 |
0 = aut. delete
1 = not aut. delete
|
Required |
| expire_date |
value: Date (DE) |
Date <= Now + 12 weeks |
TT.MM.JJJJ |
Optional |
| timeout |
value: Byte |
1 - 12 |
Now + x weeks |
If nodelpress = 0 then required. |
| |
|
|
|
|
| rules |
value: Boolean |
"false" / "true"
not 0 / 1
|
Rules agreed! |
Required |
| |
|
|
|
|
| doAPI |
value: Boolean |
"false" / "true"
not 0 / 1
|
Default: False
If true, after calling the API, will be given back the result in XML format. |
Optional |
Results (if doAPI = true!)
If no errors have occurred and the new promotion release was passed and can be stored temporarily:
<?xml version="1.0" encoding="windows-1252"?>
<api>
<results>
<result>OK</result>
<resultnr>0</resultnr>
<resultstr>Done!</resultstr>
<SID>Double</SID>
</results>
</api>
If errors have occurred:
<?xml version="1.0" encoding="windows-1252"?>
<api>
<results>
<result>Error</result>
<resultnr>Error number</resultnr>
<resultstr>Error message (string in HTML format)</resultstr>
</results>
</api>
View list of error codes and error messages.
Add a new promotion release and save it temporarily
Please note that after a successful transfer of a new promotion release it not yet been added and it not been temporarily saved! New promotion releases need to be saved after a successful transfer to us. The transfered promotion release will remain a maximum of 24 hours temporarily in a memory and wait for the final activation by the user (via email), or us. After the expire of 24 hours and the promotion release was not activated by the user or us, the promotion release will be deleted automatically from our temporary memory.
For this reason you have got from our API a "SAVE ID" (SID). Only with the SID you can add and store temporarily new promotion releases on our server.
The SID will be received after a successful transfer (data) of a new promotion release in XML format (see above):
[...]
<SID>Double</SID>
The SID might look something like this: 40063814841331
[...]
Parameters:
| save |
value: Boolean |
"false" / "true"
not 0 / 1
|
true to save the promotion release, otherwise answer HTTP 301 |
Required |
| SID |
value: Double |
assigned SID |
see above |
Required |
| doAPI |
value: Boolean |
"false" / "true"
not 0 / 1
|
Default: False
If true, after calling the API, will be given back the result in XML format. |
Optional |
Results (if doAPI = true!)
If no errors have occurred and the new promotion release is saved temporarily. An email was send to the sender with an activation link (URL), if a valid promotion shortcut was used by the sender and it have successful passed. Otherwise the new promotion release will be activate after the first audit by an administrator from werbeblaettchen.com (spam-protection).
If this new promotion release activated by an administrator and it was used a new promotion shortcut by the sender, then the new promotion shortcut will be automatically unlocked. Then it can be used for other and new promotion releases in the future.
<?xml version="1.0" encoding="windows-1252"?>
<api>
<results>
<result>OK</result>
<resultnr>0</resultnr>
<resultstr>Done!</resultstr>
</results>
</api>
If errors have occurred:
<?xml version="1.0" encoding="windows-1252"?>
<api>
<results>
<result>Error</result>
<resultnr>Error number</resultnr>
<resultstr>Error message (string in HTML format)</resultstr>
</results>
</api>
View list of error codes and error messages.
|
