Ad Serving
Admin API
>
API Reference
>
v0
>
Marketing / Ads
>
Ad Serving
openapi: 3.0.0
info:
title: Ads Serving
description: Render Ad previews. These endpoints do not result in an impression; they're solely for previewing ads created using the Ads Management service.
version: latest
servers:
- url: 'https://banno.com'
tags:
- name: ads-serving
paths:
'/a/ads-serving/api/v0/institutions/{institutionId}/ads/{adId}/document':
get:
tags:
- ads-serving
summary: >-
Preview an Ad. This is the same as the `/partial` endpoint with the addition that it
also includes the html/head/body tags so that it can be embedded in an iframe, etc. as necessary.
description: Requires the "View digital banking ads" permission
security:
- OpenIDEnterprise:
- "https://jackhenry.com/ads-serving/ads-serving.read"
parameters:
- $ref: '#/components/parameters/InstitutionId'
- $ref: '#/components/parameters/AdId'
responses:
'200':
description: OK
content:
text/html:
schema:
type: string
example: <html><head></head><body><div>...</div></body></html>
'404':
description: Http NotFound
'500':
description: Internal server error.
deprecated: false
'/a/ads-serving/api/v0/institutions/{institutionId}/ads/{adId}/partial':
get:
tags:
- ads-serving
summary: >-
Preview an Ad.
description: Requires the "View digital banking ads" permission
security:
- OpenIDEnterprise:
- "https://jackhenry.com/ads-serving/ads-serving.read"
parameters:
- $ref: '#/components/parameters/InstitutionId'
- $ref: '#/components/parameters/AdId'
responses:
'200':
description: OK
content:
text/html:
schema:
type: string
example: <div>...</div>
'404':
description: Http NotFound
'500':
description: Internal server error.
deprecated: false
'/a/ads-serving/api/v0/institutions/{institutionId}/ads/template-preview-config.css':
get:
tags:
- ads-serving
summary: >-
Returns this Institution's custom CSS, if available. This is used to preview what an Ad will look like if placed on
an Institution's website. The Url query parameter is for the Institutions homepage where their custom CSS can be found.
If this Url is not known, it can be omitted, and the service will attempt to use the default Url we have on file.
description: Requires the "View digital banking ads" permission
security:
- OpenIDEnterprise:
- "https://jackhenry.com/ads-serving/ads-serving.read"
parameters:
- $ref: '#/components/parameters/InstitutionId'
- $ref: '#/components/parameters/Url'
responses:
'200':
description: >-
OK. Includes CSS used to style Ads. If the Institution doesn't have any custom styling this will return an empty body.
content:
text/css:
schema:
type: string
example: 'html { font-size: 100% }'
'404':
description: Http NotFound.
'500':
description: Internal server error.
deprecated: false
components:
securitySchemes:
OpenIDEnterprise:
$ref: "https://jackhenry.dev/authentication-framework/security-schemes.swagger.yaml#/components/securitySchemes/OpenIDEnterprise"
clientCredentials:
type: oauth2
description: OAuth2 using the client credentials flow
flows:
clientCredentials:
tokenUrl: https://login.jackhenry.com/a/oidc-provider/api/v0/token
scopes: {}
parameters:
InstitutionId:
name: institutionId
in: path
required: true
schema:
type: string
AdId:
name: adId
in: path
required: true
schema:
type: string
Url:
name: url
in: query
required: false
schema:
type: string
format: url
Have a Question?
- Have a how-to question? Seeing a weird error? Get help in The Jack Henry Developer Community.
- Register for the Developer Office Hours where we answer technical Q&A from the audience.
Did this page help you?
Why was this page helpful?
Why wasn't this page helpful?
Thank you for your feedback!
Last updated Wed Aug 4 2021