User Agent

All API requests MUST include a valid User-Agent header. This allows us to contact you if there are problems. Requests with no User-Agent header will be rejected.

iOS User Agent Format

AppIdentifier/VersionNumber/BuildNumber(iPhoneModelIdentifier;iOS;iOSVersion;RenderingScale)

Example user agent

GreatCafe/1.2/10(iPhone8,1;iOS;7.0;2.00)

Name	Description
AppIdentifier	The client should truncate the package name of the app and only send the app identifier. For example, in package name com.punchh.greatcafe, com.punchh. should be truncated and the client should send only greatcafe in the user agent.
VersionNumber	Version number of the application
BuildNumber	Build number of the application
iPhoneModelIdentifier	iPhone model identifier. Here is a list of list of iPhone model identifiers.
iOSVersion	Version of iOS installed on the user's iPhone
RenderingScale	The scale of rendering of the user's iPhone. Here are details about the resolution of different iPhones.

Android User Agent Format

AppIdentifier/VersionNumber/BuildNumber(Android;DeviceManufacturer;ModelNumber;AndroidVersion;ScreenDensity)

Example user agent

GreatCafe/1.2/9(Android;Samsung;SM-N910P;6.0.1;mdpi)

Name	Description
AppIdentifier	The client should truncate the package name of the app and only send the app identifier. For example, in package name com.punchh.greatcafe, com.punchh. should be truncated and the client should send only greatcafe in the user agent.
VersionNumber	Version number of the application
BuildNumber	Build number of the application
DeviceManufacturer	Manufacturer of the user's device (e.g., Samsung, Motorola, etc.)
ModelNumber	Model number of the user's device. For example, Samsung Model SM-N910P is commonly known as Samsung Galaxy Note 4.
AndroidVersion	Version of Android installed on the user's device. Here is a list of Android versions.
ScreenDensity	Screen density of the user's device running Android OS. Here is a list of supported screen densities.