Introduction
SAP Project Intelligence Network is a cloud-based solution for collaboration between all partners in construction and engineering projects. The application uses a digital twin as the central point for integrating and fostering collaboration between all involved parties. From conceptualization to delivery, all partners in a project can work closely to design and build facilities and assets.
With SAP Project Intelligence Network, you can share crucial information and important documentation about the project with project partners.
SAP Project Intelligence Network also provides APIs which can be used to integrate with other applications or to extend the core capabilities offered.
Sometimes, people face difficulties in getting started with consuming such APIs by just relying on the SAP help documentation. In this blog, this is explained in a simple step-by-step manner.
Prerequisites
- You have onboarded to SAP Project Intelligence Network. Refer to the onboarding guide for more details.
- Verification criteria
- Your subaccount should have an entitlement for SAP Project Intelligence Network
- You should have subscribed to SAP Project Intelligence Network (PIN) in your subaccount with the Application plan - "standard"
- Your subaccount should have an entitlement for SAP Project Intelligence Network
- Verification criteria
- You have the necessary authorizations to manage the subaccount
Steps
Summary
- Enable Cloud Foundry in the subaccount
- Create a service instance of SAP PIN API service
- Create a service key
- Assign roles
- Perform API invocation
Enable Cloud Foundry in the subaccount
This is needed to consume services in cloud foundry. "SAP Project Intelligence Network" API service is one of such services.
- Log on to SAP Business Technology Platform cockpit
- Navigate to the subaccount by following the steps
- Select the created subaccount in the cockpit
- Choose "Enable Cloud Foundry"
- Provide a Cloud Foundry organization name, and then click on "Create"
Create PIN API service instance
The service instance that gets created shall act as an OAuth Client
- Navigate to the subaccount in BTP Cockpit where PIN is subscribed to
- Go to Services and Marketplace
- Choose "Service" from the filter for "types"
- Search for "SAP Project Intelligence Network"
- Click on the tile shown above
- Choose the "default" plan under the "Service Plans" section
- Click on "Create" button as highlighted in the screenshot
- In the dialog that opens, click on the "Create a space" link if you do not have an existing space
- Provide an appropriate name for the space name and click on "Create"
- Enter a suitable instance name
- Click on "Next"
- Optional step:
Background - When using the OAuth 2.0 authorization code grant, you can specify the allowed redirect-URIs to the application that calls PIN APIs or the integration system that handles the callback call.
The redirect URIs information has to be entered in a JSON object in the dialog
{
"xs-security": {
"xsappname": "<unique-appname>",
"oauth2-configuration": {
"redirect-uris": [
"https://<your-domain>/**"
]
}
}
}
- Optional step:
- Click on "Create"
- You'll see a success message like below
Create a service key
The service key provides the credentials to talk to the UAA associated with the subaccount and the PIN API endpoint URL
- Go to the service instance created in the previous step
- OR
- Click on "View Instance" in the previous dialog
- Click on the "Create" button in the "Service Keys" section as shown above
- Enter a name for the service key and click on "Create" in the dialog
- Now, click on "View" service key by clicking on the "..." button as shown
- Note down the values of the below parameter from the json shown
- clientid
- clientsecret
- apiurl
- url - under "uaa" in the json
Assign Roles
To execute certain operations in PIN, the necessary roles have to be assigned. Refer here.
Perform API invocation
PIN enables API access via OAuth 2.0 Authorization Code flow
- Go to Postman app
- Create a new request
- Get access token
- In the "Authorization" section choose the type as oAuth 2.0
- Provide the previously noted credentials in the Authorization screen
- You can either enter the details directly or use Postman environment variables like shown below
- Click on "Get New Access Token"
- Click on "Use Token" in the dialog
- Let's invoke the PIN Projects API to test if the credentials work
- Enter the following text in the URL field: "{{API_URL}}/ProjectService/v1/Projects"
- Replace {{API_URL}} with the "apiUrl" noted earlier
-
- Click on "Send"
- In the response, you shall get the list of projects you are authorized to view (in case projects exist)
- You can explore other APIs by referring to the APIs in SAP API Hub
Summary
I hope that after going through this blog, you were able to perform the necessary configurations as described and invoke PIN APIs.
In case of any queries, feedback w.r.t API consumption, you can post a comment. If there are general queries on SAP Project Intelligence Network please post a Question and assign the tag "SAP Project Intelligence Network"
- SAP Managed Tags:
3 Comments
