How the REST API Resource Works

An overview of the SAP Fieldglass REST API, using OAuth 2.0 protocol for authorization and URL resources for coding specifications.

Workflow

The SAP Fieldglass REST API resource allows clients to send and receive integrated data directly against the application. The API uses the OAuth 2.0 protocol for authorization. OAuth 2.0 uses tokens over HTTPS. SAP Fieldglass supports common OAuth 2.0 scenarios such as those for web server, installed, and client-side applications.

Before you can authenticate with the SAP Fieldglass REST API, a user with the Configuration Manager role must create the credentials the API uses. In Configuration Manager, create an API Application Key and a web service account. This generates the client ID, the license key used as the client secret, and the X-ApplicationKey. For instructions, see Create API Application Key or Web Service.

To begin, you must obtain OAuth 2.0 client credentials - see OAuth2 Service Authentication. Next, your client application requests an access token from the SAP Fieldglass Authorization Server, extracts a token from the response, and then sends the token to the SAP Fieldglass REST API that you want to access.

All applications follow a basic pattern when accessing an SAP Fieldglass REST API using OAuth 2.0.

The following diagram illustrates the API authentication and authorization workflow.

Connector Resource URL

https://<SAP Fieldglass environment URL>/api/vc/connector/<connector name>

  • Download connectors submit an HTTP GET request.

  • Upload connectors submit an HTTP POST or PUT request.

  • Standard connector parameters can be specified by adding the "__p1", "__p2", etc. query string parameter to the URL, e.g. https://<SAP Fieldglass environment URL>/api/vc/connector/<connector name>?__p1=X.

Refer to the SAP Connector Library to access details on specific connectors.

Approvals Resource URL

https://<SAP Fieldglass environment URL>/api/v1/approvals

Real-time push requests are sent to the end point identified by the customer. To fulfill the request, SAP Fieldglass needs to receive the following details:

  • End Point URL

  • Username and Password credentials

To access additional SAP Fieldglass API resources on the SAP API Business Hub, go to https://api.sap.com/package/FieldglassAPI?section=ArtifactsInformation published on SAP site.

For more information on implementing REST APIs contact the Customer Support Help Center for SAP Fieldglass.