Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Die PEIQ Ad API bietet Zugang den Daten aus dem PEIQ PRINT Werbemarkt:

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.

...

Der aktuelle Funktionsumfang kann über Swagger UI eingesehen werden:

Info

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.

...

Status
colourBlue
titleGET

/ads/values/categories

Get tree of all categories for ads.

Status
colourBlue
titleGET

/ads/values/assignments

Get a list of all assignments

Status
colourBlue
titleGET

/ads/values/types

Get all ad types

Status
colourBlue
titleGET

/ads/values/producttypes

Get all ad product types

Status
colourBlue
titleGET

/ads/values/billingclients

Get all billing clients

Status
colourBlue
titleGET

/ads/values/bookableissues

Get all bookable issues

Link in Swagger-UI

API-Endpunkt “Business Partners”

...

Status
colourGreen
titlePOST

/businesspartners

Create Business Partner

Status
colourYellow
titlePUT

/businesspartners/{number}

Update Business Partner by unique (NGEN) number

Status
colourBlue
titleGET

/businesspartners/{number}

Get Business Partner Information by unique (NGEN) number

Status
colourBlue
titleGET

/businesspartners/search

Search for Business Partner

Status
colourBlue
titleGET

/businesspartners/events

Get changed Business Partner Information since last retrieval

Link in Swagger-UI

API-Endpunkt “Account Details”

...

Status
colourGreen
titlePOST

/accountdetails/

Create new SEPA account details

Status
colourYellow
titlePUT

/accountdetails/{number}

Update SEPA account details

Status
colourBlue
titleGET

/accountdetails/{number}

Get SEPA account details

Link in Swagger-UI

API-Endpunkt “Addresses”

Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:

Status
colourGreen
titlePOST

/addresses

Create new address

Status
colourYellow
titlePUT

/addresses/{number}

Update address

Status
colourBlue
titleGET

/accountdetails/{number}

Get address

Link in Swagger-UI

API-Endpunkt “Advertisements”

...

Status
colourGreen
titlePOST

/ads

Create new ad

Status
colourYellow
titlePUT

/ads/{number}

Update ad by unique (NGen) number

Status
colourBlue
titleGET

/ads/{number}

Get ad by unique (NGen) number

Status
colourBlue
titleGET

/ads/events

Get changed ads since last retrieval

Status
colourYellow
titlePUT

/ads/images/{number}

Update image data for ad

Status
colourBlue
titleGET

/ads/images/{number}/{resolution}

Get an image of the advertisement by unique NGEN number

Link in Swagger-UI

API-Endpunkt “Ad cipher number”

...

Status
colourBlue
titleGET

/abc/cipher_number

Get a unique cipher number

Link in Swagger-UI

API-Endpunkt “Supplements”

...

Status
colourGreen
titlePOST

/supplements

Create new supplement

Status
colourYellow
titlePUT

/supplements/{number}

Update supplement by unique (NGen) number

Status
colourBlue
titleGET

/supplements/{number}

Get supplement by unique (NGen) number

Link in Swagger-UI

API-Endpunkt “Sales”

Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:

Status
colourGreen
titlePOST

/sales

Create new sale

Status
colourYellow
titlePUT

/sales/{number}

Update sale by unique (NGen) number

Status
colourBlue
titleGET

/sales/{number}

Get sale by unique (NGen) number

Link in Swagger-UI

API-Endpunkt “Orders”

Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:

Status
colourGreen
titlePOST

/orders

Create new order

Status
colourYellow
titlePUT

/orders/{number}

Update order by unique (NGen) number

Status
colourBlue
titleGET

/orders/{number}

Get order by unique (NGen) number

Link in Swagger-UI

API-Endpunkt “Order price calculation”

...

Status
colourGreen
titlePOST

/orders/calculate_price

Calculate the price for an order

Status
colourBlue
titleGET

/orders/calculate_price/{number}

Calculate the price for the given order

Link in Swagger-UI

API-Endpunkt “Info”

Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:

Status
colourBlue
titleGET

/info

Get API an user info

Link in Swagger-UI

API-Endpunkt “Invoices”

Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:

Status
colourBlue
titleGET

/orders/invoices/events

Get changed invoices since last retrieval

Status
colourBlue
titleGET

/orders/invoices/{number}

Get invoice data

Link in Swagger-UI

API-Endpunkt “Commissions for orders”

...

Status
colourBlue
titleGET

/orders/commissionstatements/events

Get changed commission statements since last retrieval

Status
colourBlue
titleGET

/orders/commissionstatements/{number}

Get data for commission statement

Link in Swagger-UI

API-Endpunkt “Special Publications”

...

Status
colourGreen
titlePOST

/specialpublications

Create new special publication

Status
colourYellow
titlePUT

/specialpublications/{number}

Update special publication by unique (NGen) number

Status
colourBlue
titleGET

/specialpublications/{number}

Get special publication by unique (NGen) number

Status
colourBlue
titleGET

/specialpublications/search

Search for special publications

Link in Swagger-UI

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel in ( "api" , "api-dokumentation" , "werbemarkt" , "adapi" ) and space = "PPSD"
Include Page
PUPKB:Disclaimer der PEIQ PORTAL - Produktdokumentation
PUPKB:Disclaimer der PEIQ PORTAL - Produktdokumentation