Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Accessing Pega Process Fabric Hub registration APIs

Updated on September 21, 2021

Explore the Pega Process Fabric Hub APIs in order to register your third-party application in the Pega Process Fabric Hub, and as a result resolve work faster.

Before you begin:
  • To generate a client secret and client ID, you must have the Application:Administrators access group.
  • To view and invoke the Pega Process Fabric Hub registration APIs, you must have the PPF:Configurators access group set as the default access group.
Note: An administrator can generate registration credentials, and then share the credentials with multiple configurators to register and manage multiple applications.
To access the list of Pega Process Fabric Hub APIs in the Swagger doc, obtain a client ID and a client secret because OAuth 2.0 authentication secures the Pega Process Fabric Hub APIs. You then obtain an access token by invoking a relevant endpoint. After you obtain the access token, you can manage any number of application registrations in the Pega Process Fabric Hub.

Obtaining client credentials for Pega Process Fabric Hub registration APIs

In order to access the Pega Process Fabric Hub APIs in the Swagger documentation, obtain relevant client secret and client ID.

  1. In the navigation pane of Dev Studio, click Records.
  2. Expand the Security category, and then click OAuth 2.0 Client Registration.
  3. In the header of the list of client registration instances, click Create.
  4. In the Short description field, describe the purpose of the client registration.
  5. In the Client Name field, enter the identifier for the client registration.
  6. Click Create and open.
  7. On the Client information tab, configure the client registration:
    1. In the Client Credentials section, in the Type of client list, select Confidential.
    2. In the Supported grant types section, select the Client credentials check box.
      Note: Ensure that you clear the remaining check boxes.
    3. In the Set operator context using subsection, select Operator ID, and then, in the Operator ID field, enter the operator for whom you want to generate the credentials.
      Note: The Pega Process Fabric Hub recognizes the API calls that operators make by using generated client secret and client ID as calls on behalf of the operator that you specify in the Operator ID field. As a best practice, generate a separate set of client secret and client ID for every operator that want to makes the API calls to the Pega Process Fabric Hub.
    For example: The following figure shows how to configure client registration in order to access the Pega Process Fabric Hub endpoints:
    Client registration details
    Client registration rule form with details appropriate for accessing Pega Process Fabric Hub endpoints
  8. In the Client Credentials section, click View & download.
  9. In the View & download dialog box, click Download credentials.
  10. In the Save As dialog box, select a secure location on your local system to save the file that contains the configurator credentials, and then click Save.
  11. In the header of the record, click Save.
  12. If you generate a client ID and client secret for another configurator, share the generated credentials with the configurator in a secure manner.

Obtaining access token for Pega Process Fabric Hub Hub registration APIs

After you generate client credentials, obtain an access token in order to manage applications in the Pega Process Fabric Hub by invoking API calls.

  1. Invoke the access token endpoint https://process-fabric-domain/prweb/PRRestService/oauth2/v1/token by using a POST method and entering the following request body:
    client_id=client_ID&client_secret=client_secret&grand_type=client_credentials
Result: The response includes the access token and the expiration duration in seconds. After the access token expires, you can use the same client ID and client secret to obtain the access token by invoking the access token endpoint. The following code is a sample JSON response with a response status of 201:
{ 
  "access_token": "eyJraWQiOiI1OTA0ZDc1YmYxN2QxMTIxNDY0NjI1ZWZiZTk5YjE5YSIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJhdWQiOiJ1cm46Njk4ODYwNzYzMjM1MTk4NjAzMzYiLCJzdWIiOiJhcmVrczEiLCJhcHBfbmFtZSI6IlBQRiIsIm5iZiI6MTYxOTA2Nzg0OSwiYXBwX3ZlcnNpb24iOiIwMS4wMS4wMSIsImlzcyI6InVybjp2bGVuZ2h5ZGNudDE3MjYzLXByb2Nlc3NmYWJyaWNodWIubGFiLnBlZ2EuY29tIiwiZXhwIjoxNjE5MDcxNDQ5LCJpYXQiOjE2MTkwNjc4NDksImp0aSI6ImRkMDRhMjdlYTZiOTZhMWZkNGJjNjhmY2Y1YTg4MjJhIiwib3BlcmF0b3JfYWNjZXNzIjoiUFBGOkFkbWluaXN0cmF0b3JzIn0.enqE97R9VIvVZdzTugh_1Qwhntia0aKWKri9gdjtaGRbCxsxa3rulEOl7Q57jJIivbRP2hVPwLKnxPC2LC4hNoGdDBt4-AOHm0Pqw5_x9RYwIGjdgnfpEt_9UCMrjv2RJlfw0Ae7QRwV22VbS8_be881e6I53MTLeVQqmSCSyjpTaaY9u75vKhqQQ0UJYaui2qRhTiUsucn2ri3xike60IDDpnOIFotbIRbsvXAMM-jeM-F-m5YsqErCJqIklhaurVDddbrteexL9CYu1esq6CfrAn-eYza5K9E8VDFOj8QUOEwlGAPXBVgLaobElxKew5W8tdHEpIvFYjrpjZA5GjmKzqPd3zZVgNrdfDU-liII2bXaIEZg89A8JLNXxy8BJg0Yil3lyTf9ugEGhvPAUDaRqHLfrpbPspIpwKp6zV6Nj1L-qUk6lAlhvQlROvzM-_1pJbJ70M9ZLrK40-1GE0xGu-hFW6hUzEK8fexXl_WeTht6Eldqi-38H5YDR93OIKCp4FutLiwPf9HfSui9U0Usq4pBipA6JKnq_9MaYOJN3uliiocfjb5yXc5ZcJ4XKYdDFw4YaZdhDTeBcV3EIkcYVewaSUYB4ImVp9A4NqLOiHBLy73DtXNYGcy7pNYujGVRXvOrKWaxt6w03Fd3dQPoIRwUyMdSbzmvz_HfVhg", 
  "token_type": "bearer", 
  "expires_in": 3600 
}
In the above example, the request URL is https://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/PRRestService/oauth2/v1/token, and the request header is Content-Type: application/x-www-form-urlencoded. You can use the access token to invoke registration APIs.
What to do next: Register and then manage your application by invoking relevant REST APIs. For example, obtain access to data synchronization APIs by invoking the Activation Registration API.
  • Previous topic Registration APIs for the Pega Process Fabric Hub
  • Next topic Create Registration Pega Process Fabric Hub endpoint

Related articles

Data Synchronization APIs for the Pega Process Fabric Hub

Tags

Pega Process Fabric Hub 1.0 Case Management

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Visit the Support Center

Did you find this content helpful?

Yes
No

Want to help us improve this content?
Suggest an edit

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us