Registering at the PNC Developer Portal

Transcription

1 Registering at the PNC Developer Portal 1.) Navigate to the Developer Portal at: 2.) Click the Join button on the upper right corner of the Developer Portal page: 3.) Enter in your address, name, and a password. For the Organization field, enter in a unique name of your choice (e.g. My CMU hacking team ), and click the Join button:

2 4.) You will receive a Success notification and an activation will be sent to the address provided. The message will be from APIManager with the subject Welcome to PNC. Once this arrives, click the link contained within the to activate your PNC developer account: 5.) After clicking the activation link, you will be taken to the Developer Portal. You can now sign in with your new account. Click the Sign in link and enter in your address as your username and the password you selected when setting up your account, then click the Sign In button: 6.) Next you must register an application in order to start using the API calls. Click the Applications icon on the left side of the Developer Portal. Then click the + Application link to register a new application:

3 7.) A dialog box will appear allowing you to create an application name of your choice. For example, My_Test_PNC_App. Then click the Add button to register the application: 8.) This will take you to a new page that confirms the application has been registered. There is a section for the Client ID, we must use this value for all the API calls that we make. The Client Secret value is currently not used by the API calls: 9.) Click the Show button next to the Client ID text box to reveal its value. Copy this value so it can be used later in the API calls:

4 10.) Sign off from the Developer Portal. Then let the PNC team know that you have successfully followed the steps up to this point. A PNC Admin will grant you access to the API s from their side. Once PNC has confirmed they have granted you access, please sign back in to the Developer Portal and continue following the steps below. 11.) Now click the APIs icon on the left side of the Developer Portal to see the API s that you have access to. This will show the list of services available for Tartan Hacks: 12.) Now you must select an API plan to use. To do this, click on the Admin API. Then, on the right side of this page, click the Select a plan link, and select Basic. This will allow you to use all the services under the Basic plan:

5 13.) After selecting the Basic plan, confirm the selection by clicking the Use this plan button: 14.) You will see a confirmation dialog box appear. Select the name of the application you registered, then click the Use this plan button: 15.) Click the APIs icon again to return to the list of services. You are now ready to begin making API calls to the PNC system. You can also invite other users to the Developer Portal at this point. Invited user will be automatically granted access to the same API s you have access to. To invite other users, please see the section Inviting Other Users to the PNC Developer Portal further on in this document. (continued on next page)

6 16.) Please note: Most of the API calls will require a customerkey field. This is a unique number that identifies a particular customer. Your first API call should be to the Admin > createcustomer service. This will generate a new customer, populate that customer data, and return the customerkey value to the user. This customerkey value can then be used in all subsequent API calls. Under the API list, find the one for: Admin. Then click the + symbol under the Details column for the createcustomer call: The URL in this section shows the endpoint for the REST call, as well as the required client_id parameter. The Response Body section will show an example of the JSON response for this call. The Test section will allow you to experiment with the REST API calls within the Developer Portal. You can optionally enter in data for a sample request, then click the Invoke icon. This will call the service and display the response body within the Developer Portal. For the createcustomer service, you can simply click the Invoke icon to test the service. The customerkey returned here can be used in all your other requests:

7 17.) PNC support contact information and additional API reference documentation and FAQ s can be found under the Contact Support link on the Developer Portal: (continued on next page)

8 Inviting Other Users to the PNC Developer Portal Once you have successfully registered on the Developer Portal and PNC has granted you access to the API s, you can invite other users to register at the Developer Portal. These users will receive an invite to register. Once they are registered, they will have access to all the API s that you do. To invite other users, please follow the steps below. A. Log in to the PNC Developer Portal at: B. On the left side, click the Users icon: C. Click the + User icon: D. This will open a dialog box. Click the New User tab within this dialog:

9 E. Enter in the users address. Then click the blue + icon under the Assign Role section and select the Developer role: F. Click the Save button to send an invite to the user: G. A confirmation message will appear letting you know the invite has been sent. This new user will appear under the Users section with a status of Invitation Pending : The user will receive an with the subject Welcome to PNC. It will contain a link that will allow them to register at the Developer Portal. Once they register and log in for the first time, their status will change to Active. The next section, Registering from an Invite, details how a user will register once they receive the invite.

10 Registering from an Invite Another way to register at the PNC Developer Portal is to be invited by other users that have already registered. These registered users can send you an invite. The contains a link that allows you to register on the PNC Developer Portal. Once you register, you will be automatically granted access to all the same API s that the register user has access to. To register from an invite, follow the steps below: i. Check your inbox for a message with the subject Welcome to PNC from APIManager. This will contain a link to activate your account, click this link: ii. Clicking the link opens the Developer Portal and brings up a registration box. Enter in your first and last name, as well as a password. Then click the Join button: (continued on next page)

11 iii. After this dialog box disappears, you ll need to click the Sign in link to log in to the Developer Portal with your new account: iv. Enter in your address and password, then click the Sign in button. This will log you in and allow you to access the PNC API s: