This is in beta. If you find something wrong, let us know

Australian Trade Mark Search API

Getting Started

Authentication

Authentication

Overview

IPAustralia APIs enforce the OAuth 2.0 protocol for application and user authorisation. OAuth is the industry standard for assuring that online transactions are secure and your application must need provide a valid access token for each request it makes to the IP Australia API.

The OAuth 2.0 framework specifies several grant types for different use cases and IP Australia External Token API provides access tokens for following grant types:

Client credentials grant - Application access token

**This grant is intended for B2B Partner Applications to get access token using the provided client id/secret keys. **

The Client Credentials grant is used when applications request an access token to access their own resources, not on behalf of a user.

**Authorization code grant - **User access Token

**This grant is intended for 3rd Party Developer Apps to get access token on behalf of their end user. **

To be implemented in future


External Token API Endpoints

TEST

https://test.api.ipaustralia.gov.au/public/external-token-api/v1/access_token

PRODUCTION

https://production.api.ipaustralia.gov.au/public/external-token-api/v1/access_token

How to call API with OAuth Security Token

  1. Obtain OAuth2 Access Token From External Token API

Send HTTP Post Request to IPAustralia's External Token API with following form parameters:

grant_type=client_credentials
client_id={Client_ID}
client_secret={Client_Secret}

Sample Request

POST https://test.api.ipaustralia.gov.au/public/external-token-api/v1/access_token HTTP/1.1
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&
client_id=73oam0iel1n9tf98cn00lja662&
client_secret=17gt5kvgkgn82ocu8dlh6gq50t1lke569i1jhigrvtjbiae807j2

OAuth Access token (Json Web Token) is returned in the response JSON Payload under "access_token" as below:

Sample Response:

HTTP/1.1 200 OK

{
   "access_token" : "eyJraWQiOiJWc2kyU0l0SkpvN1pzekRzWWNDUWlUU1wvTFJQeHEyVW50MDc5ZjNSSTFpbz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI3M29hbTBpZWwxbjl0Zjk4Y24wMGxqYTY2MiIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiaHR0cHM6XC9cL2FwaS5pcGF1c3RyYWxpYS5nb3YuYXVcL2IyYlwvaXByaWdodHNcL2FnZW50IiwiYXV0aF90aW1lIjoxNTQ2NDg1MjA1LCJpc3MiOiJodHRwczpcL1wvY29nbml0by1pZHAuYXAtc291dGhlYXN0LTIuYW1hem9uYXdzLmNvbVwvYXAtc291dGhlYXN0LTJfV3pLa2FnemhQIiwiZXhwIjoxNTQ2NDg4ODA1LCJpYXQiOjE1NDY0ODUyMDUsInZlcnNpb24iOjIsImp0aSI6ImRmYzliYTlkLWYzYzUtNDA4YS04Y2Y5LTA1ZmNhZDhhN2JjZiIsImNsaWVudF9pZCI6Ijczb2FtMGllbDFuOXRmOThjbjAwbGphNjYyIn0.nl-Gncp1uBK1qvOMCQY45oA8ekgu6q77SfOU94xeC1lkqM_dX4sASxIw5IambMd6ofJwXG5pz3Fw-zx4td_h36Wj4tIEdUkbk9Z2xadw8HNndBiPxqjrB3VfjkL22Dq7Tf0HCxJ3zQ_NSGb_5gbTA2RHx2lS7Z0qDGgk8JsriauZ4p-s-XALDjsvmaCAm_uQ67XSB1t3SRsUI9DFMA0974Cnn3a_lmyZ7WpgIEVhFffjTmBhiD2p6c8Jg2Mc6Beas9zLUgPtR8aNrHddCuzkXf19Q7s3C0c7hurPRMnfQcnKODYaLrWv9a56ZtNnmkuzMm_W3dcSXWyLH-3eFxgrrA",
   "expires_in" : 3600,
   "token_type" : "Bearer"
}

Access Token is valid for 1 hour, hence the same token can be reused across multiple API requests.

2.** **Pass OAuth Access Token in the HTTP Header of the actual API Request

Send the above OAuth Token in HTTP Authorisation Header of the API Request in the below format:

Authorizaton: {token_type} + space + {access_token}

Sample Patent Renewal Request


POST https://test.api.ipaustralia.gov.au/public/ipright-management-b2b-api/v1/patents/2018219977/renew HTTP/1.1

Authorization: Bearer eyJraWQiOiJWc2kyU0l0SkpvN1pzekRzWWNDUWlUU1wvTFJQeHEyVW50MDc5ZjNSSTFpbz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI3M29hbTBpZWwxbjl0Zjk4Y24wMGxqYTY2MiIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiaHR0cHM6XC9cL2FwaS5pcGF1c3RyYWxpYS5nb3YuYXVcL2IyYlwvaXByaWdodHNcL2FnZW50IiwiYXV0aF90aW1lIjoxNTQ2NDg1MjA1LCJpc3MiOiJodHRwczpcL1wvY29nbml0by1pZHAuYXAtc291dGhlYXN0LTIuYW1hem9uYXdzLmNvbVwvYXAtc291dGhlYXN0LTJfV3pLa2FnemhQIiwiZXhwIjoxNTQ2NDg4ODA1LCJpYXQiOjE1NDY0ODUyMDUsInZlcnNpb24iOjIsImp0aSI6ImRmYzliYTlkLWYzYzUtNDA4YS04Y2Y5LTA1ZmNhZDhhN2JjZiIsImNsaWVudF9pZCI6Ijczb2FtMGllbDFuOXRmOThjbjAwbGphNjYyIn0.nl-Gncp1uBK1qvOMCQY45oA8ekgu6q77SfOU94xeC1lkqM_dX4sASxIw5IambMd6ofJwXG5pz3Fw-zx4td_h36Wj4tIEdUkbk9Z2xadw8HNndBiPxqjrB3VfjkL22Dq7Tf0HCxJ3zQ_NSGb_5gbTA2RHx2lS7Z0qDGgk8JsriauZ4p-s-XALDjsvmaCAm_uQ67XSB1t3SRsUI9DFMA0974Cnn3a_lmyZ7WpgIEVhFffjTmBhiD2p6c8Jg2Mc6Beas9zLUgPtR8aNrHddCuzkXf19Q7s3C0c7hurPRMnfQcnKODYaLrWv9a56ZtNnmkuzMm_W3dcSXWyLH-3eFxgrrA

{

   "submitterReference" : "MyPatentRenewal",

   "numOfYearsToRenew" : "1"

}


Last edited: 19 May 2020, 10:48:15