PEIQ Knowledge Base
PEIQ Ad API
- Torsten Konnopasch
- Martin Schulze
- Kathrin Janka
Die PEIQ Ad API bietet Zugang den Daten aus dem PEIQ PRINT kaufmännischen Anzeigensystem:
kaufmännischen Anzeigensystem: Geschäftspartner:innen-Datenbank, Auftragserfassung, Fakturierung, Provisionierung
technisches Anzeigensystem: Technische Produktion und extern zugreifbarer Anzeigenmanager
Mit der PEIQ Ad API können Geschäftspartner- und kaufmännische Anzeigendaten übertragen, geändert und abgerufen werden. Strukturdaten, Anzeigenmotive und Seitenbelege können ebenso abgerufen werden.
Die PEIQ Ad API ist nach dem restful Prinzip und nach OpenAPI Specification aufgebaut.
PEIQ entwickelt eine Ad API für die zentralen Usecases des PEIQ kaufmännischen Anzeigensystems.
Nicht alle Funktionen des PEIQ kaufmännischen Anzeigensystems sind über die Ad API steuerbar. Funktionen, die über die API ausgeführt werden können, können auch im PEIQ kaufmännischen Anzeigensystem benutzt werden. Funktionen, die dem PEIQ kaufmännischen Anzeigensystem vorbehalten sind, werden durch die Ad API nicht beeinflusst.
Empfohlene Workflows für Anbindung an die PEIQ Ad API
Nicht alle Funktionen des PEIQ kaufmännischen Anzeigensystems sind über die Ad API steuerbar. Die Entwicklung der Ad API ist noch nicht vollständig abgeschlossen - sie befindet sich aktuell in kontinuierlicher Weiterentwicklung. Bereiche der API werden mit fortlaufender Entwicklung vom Alpha-Status in den Beta-Status und Betrieb übergehen. PEIQ wird dazu informieren.
Im Prodsystem wird der Betrieb der APIs gemonitort und innerhalb eines festgelegten Zeitrahmens entstört.
Bei der Vorliegenden Dokumentation zur Ad API handelt es sich um eine generische API. Es kann sein, dass bestimmte Anwendungsfälle nicht durch die API abgedeckt sind. Demzufolge kann es vorkommen, dass nicht alle in der API beschriebenen Felder in NGEN wiedergefunden werden können. Kundenspezifische Konfigurationen können beispielsweise auch dazu führen, dass hier beschriebene Felder in NGEN nicht zur Verfügung stehen und nicht verwendet werden können.
Bereiche der Ad API
Der aktuelle Funktionsumfang kann über Swagger UI eingesehen werden:
Ad API Swagger-UI
Bitte konkrete Parameter, Beispiel-Werte und Pflichtfelder den jeweiligen Links aus der Swagger-UI entnehmen.
Die Bereitstellung der Zugangsdaten zur Authentizifierung erfolgt durch PEIQ.
Inhaltsverzeichnis API-Ebenen
API-Endpunkt “Structure data”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
status:GET | /ads/values/categories | Get tree of all categories for ads. |
status:GET | /ads/values/assignments | Get a list of all assignments |
status:GET | /ads/values/types | Get all ad types |
status:GET | /ads/values/producttypes | Get all ad product types |
status:GET | /ads/values/billingclients | Get all billing clients |
status:GET | /ads/values/bookableissues | Get all bookable issues |
status:GET | /supplments/values/assignments | Get a list of all assignments |
status:GET | /valuelists | Get list of values. → Abfrage einfacher Wertelisten |
API-Endpunkt “Business Partners”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
status:POST | /businesspartners | Create Business Partner |
status:PUT | /businesspartners/{number} | Update Business Partner by unique (NGEN) number |
status:GET | /businesspartners/{number} | Get Business Partner Information by unique (NGEN) number |
status:GET | /businesspartners/search | Search for Business Partner |
status:GET | /businesspartners/events | Get changed Business Partner Information since last retrieval |
API-Endpunkt “Account Details”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
status:POST | /accountdetails/ | Create new SEPA account details |
status:PUT | /accountdetails/{number} | Update SEPA account details |
status:GET | /accountdetails/{number} | Get SEPA account details |
API-Endpunkt “Addresses”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
status:POST | /addresses | Create new address |
status:PUT | /addresses/{number} | Update address |
status:GET | /accountdetails/{number} | Get address |
API-Endpunkt “Advertisements”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
status:POST | /ads | Create new ad |
status:PUT | /ads/{number} | Update ad by unique (NGen) number |
status:GET | /ads/{number} | Get ad by unique (NGen) number |
status:GET | /ads/events | Get changed ads since last retrieval |
status:PUT | /ads/images/{number} | Update image data for ad |
status:GET | /ads/images/{number}/{resolution} | Get an image of the advertisement by unique NGEN number |
API-Endpunkt “Ad cipher number”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
status:GET | /abc/cipher_number | Get a unique cipher number |
API-Endpunkt “Supplements”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
status:POST | /supplements | Create new supplement |
status:PUT | /supplements/{number} | Update supplement by unique (NGen) number |
status:GET | /supplements/{number} | Get supplement by unique (NGen) number |
status:GET | /supplements/events | Get ids of created or changed supplements and/or orders since last retrieval |
API-Endpunkt “Sales”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
status:POST | /sales | Create new sale |
status:PUT | /sales/{number} | Update sale by unique (NGen) number |
status:GET | /sales/{number} | Get sale by unique (NGen) number |
API-Endpunkt “Orders”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
status:POST | /orders | Create new order |
status:PUT | /orders/{number} | Update order by unique (NGen) number |
status:GET | /orders/{number} | Get order by unique (NGen) number |
API-Endpunkt “Order price calculation”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
status:POST | /orders/calculate_price | Calculate the price for an order |
status:GET | /orders/calculate_price/{number} | Calculate the price for the given order |
API-Endpunkt “Info”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
status:GET | /info | Get API an user info |
API-Endpunkt “Invoices”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
status:GET | /orders/invoices/events | Get changed invoices since last retrieval |
status:GET | /orders/invoices/{number} | Get invoice data |
API-Endpunkt “Commissions for orders”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
status:GET | /orders/commissionstatements/events | Get changed commission statements since last retrieval |
status:GET | /orders/commissionstatements/{number} | Get data for commission statement |
API-Endpunkt “Special Publications”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
status:POST | /specialpublications | Create new special publication |
status:PUT | /specialpublications/{number} | Update special publication by unique (NGen) number |
status:GET | /specialpublications/{number} | Get special publication by unique (NGen) number |
status:GET | /specialpublications/search | Search for special publications |
status:GET | /specialpublications/events | Get ids of created or changed special publications since last retrieval |