API Getting Started
Application Programming Interfaces, or APIs, not only connect software to software but also help to create entire commercial ecosystems. The resulting API platform is going to be one of the core building blocks of our ongoing digital maturity and process automation journey within Woolworths. APIfication will ensure all of our applications are connected; making data available for others to leverage through our API catalogue. This will save development time and more importantly, will allow better access to our data - ultimately changing the way our enterprise conducts business.
API Consumption Process
In woolworths group, there are number of API management platform such as Enterprise Apigee API Platform, WooliesX Apigee API Management, Layer7 API Platform and Azure API Management.
By using this portal, you can get the access for Enterprise Apigee API Platform only and follow the instruction "Apigee Platform API Process". For other domain API platform, please follow the instruction "Other Platform API Process".
Apigee Platform API Process
Register and Login
1. Register in APIPortal to view and consume APIs.
1.1. To register, From the home page click on Register
1.2. Complete the API catalog user registration form
1.3. Click on Create New Account
2. After the registration, you will get the email.
2.1. you will get a notification email advising your registration request has been sent for approval.
2.2. Once It is approved, you will receive an activation e-mail from Woolworths API Portal <[email protected]>.
3. Login to the API Portal to browse and consume the catalogue of APIs.
3.1. From the home page, Click on Login.
3.2. Use the crendentials provided to Login to the API Portal
Explore APIs and SOAP APIs
1. Click on the APIs or SOAP APIs menu from the home page to explore avilable APIs (Alternatively, From the home page scroll down and select the available APIs from the catagory catalogue)
2. By default, all the available APIs will be displayed.
2.1. If required, you can filter by API Category and the Type of API Platform (Apigee API or Other Domain API)
2.2. Click the API Which you want to explore.
To consume the APIs for your application registration of the APP and approval to consume that API is required
1. Scroll down and view the product name from the API specs description
2. Go to My Apps section from the home page
3. Select Add a new APP button, enter your own APP name and select the product name which you need to access
4. Click on Create App button.
4.1. An approval process will be triggered
5. Once your registration request is approved by the Woolworths IT Integration team (ETA : Three working days)
6. Your APP will now be visible in the My Apps page.
6.1. Select your APP to view the Consumer Key and Consumer Secret
7. Consume the API with these Key and Secret. Additional instruction about consuming APIs is available in the APIs page (Refer Explore APIs and SOAP APIs section)
Other Platform API Process
Register and Login
1. Register in APIPortal to view and consume APIs.
1.1. To register, From the home page click on Register
1.2. Complete the API catalog user registration form
1.3. Click on Create New Account
2. After the registration, you will get the email.
2.1. you will get a notification email advising your registration request has been sent for approval.
2.2. Once It is approved, you will receive an activation e-mail from Woolworths API Portal <[email protected]>.
3. Login to the API Portal to browse and consume the catalogue of APIs.
3.1. From the home page, Click on Login.
3.2. Use the crendentials provided to Login to the API Portal
Explore APIs and SOAP APIs
1. Click on the APIs or SOAP APIs menu from the home page to explore avilable APIs (Alternatively, From the home page scroll down and select the available APIs from the catagory catalogue)
2. By default, all the available APIs will be displayed.
2.1. If required, you can filter by API Category and the Type of API Platform (Apigee API or Other Domain API)
2.2. Click the API Which you want to explore.
Get the API Access and Try it
1. Reachout to the Woolworths IT Integration team ([email protected]) to get the access information.
2. Consume the API with these access information. Additional instruction about consuming APIs is available in the APIs page (Refer Explore APIs and SOAP APIs section)
Forums:
Raise your questions and share your ideas within our API community by selecting the relavant Forum category
1. To create a new post, select the New topic button.
1.1. Enter the subject name, select the forum category and enter your questions/ideas
1.2. Save the topic
2. To response to comments on a particular post, select Post reply
2.1. Enter the comments and save