Smart Trade Mark API
home
Overview
The Smart Seal API enables the creation and management of Smart Seals. This API contains a mixture of public and private endpoints.
Base URL
TEST
The base URLs for the Test instance of Smart Seal API is:
Public:
https://test.api.ipaustralia.gov.au/public/smart-seal-api/v1/
Private:
https://internal.api.mule.nonprod.aws.ipaustralia.gov.au/smart-seal-api-uat/v1/
PRODUCTION
The base URLs for the Production instance Smart Seal API is:
Public:
https://production.api.ipaustralia.gov.au/public/smart-seal-api/v1/
Private:
https://internal.api.mule.prod.aws.ipaustralia.gov.au/smart-seal-api-prod/v1/
Requests
Smart Seal API has four endpoints:
Create Seal
/seals
This endpoint allows a user to create a Smart Seal, a seal can only contain a domain name, or a product reference but not both.
Method: POST
Request Path: /seals
Get Seals By Customer ID
/seals?ipaCustomerID={{ipaCustomerID}}
This endpoint enables a user to get all of the Smart Seals owned by the given IPA Customer ID
Method: GET
Request Path: /seals
Query Parameters:
- ipaCustomerID: the IPA Customer ID you wish to search.
Get Seal
/seals/{sealIdentifier}
This endpoint allows a user to get the detials of a Smart Seal by its ID.
Method: GET
Request Path: /seals/{sealIdentifier}
Verify Seal
/seals/{sealIdentifier}/verify
This endpoint is used to verify that a given Smart Seal matches the domain that it is being used on. This utilises the referer header to check the sending domain against the seals stored domain.
Method: POST
Request Path: /seals/{sealIdentifier}/verify
Click Seal
/seals/{sealIdentifier}/click
This endpoint is used to assist with tracking how many users have clicked on a given seal when it is on a website. This endpoint is a non-functional endpoint that is called by the seal script that runs when a site uses a seal.
Method: POST
Request Path: /seals/{sealIdentifier}/click
Response Format
All responses are in JSON