Getting Started

This service generates Government branding images consistent with the guidelines

Key Information

This service not monitored or setup to horizontally scale.

Use it in production at your own risk.

You’re better off using it to generate images and then serve them yourself

Examples

Inline

https://api-gov-au-crest-branding.apps.y.cld.gov.au/inline.png?agency=Department+Of+Finance&height=200

Stacked

https://api-gov-au-crest-branding.apps.y.cld.gov.au/stacked.png?agency=Department+Of+Finance&height=200

Inline with multiple agencies

https://api-gov-au-crest-branding.apps.y.cld.gov.au/inline.png?agency=Department+Of+Health&agency=Department+of+Foreign+Affairs+and+Trade&agency=Attorney-General%27s+Department&height=200

Stacked with multiple agencies

https://api-gov-au-crest-branding.apps.y.cld.gov.au/stacked.png?agency=Department+Of+Health&agency=Department+of+Foreign+Affairs+and+Trade&agency=Attorney-General%27s+Department&height=200

Inline and tertiary (also with forced new line)

https://api-gov-au-crest-branding.apps.y.cld.gov.au/inline.png?agency=Department+of+the%0APrime+Minister+and+Cabinet&agency=%7CGovernment+Branding+Unit&height=200

Basic usage

There are two endpoints:

Inline usage

https://api-gov-au-crest-branding.apps.y.cld.gov.au/inline.png

Stacked usage

https://api-gov-au-crest-branding.apps.y.cld.gov.au/stacked.png

Params

Both endpoints take the same parameters:

agency

The name of the agecny to display.

You can add as many ‘&agency’ paramaters as you like, they will be added in order.

The guidelines cater for sub-headings, for things such as function names.

These use a non-bold font.

Lines won’t wrap.

If you want to break up a line, add a newline (\n, or %0A).

If you want to add a comma, use $2C (also works for any other %-prefixed characters that might get munged)

height

Sets the total height of the image.

The width is derrived based on the longest ‘agency’ parameter

square

Overrides the natural aspect-ratio of the images and pads it out to be a square