Developer Portal - My Applications
Thanks for registering! You now have access to all the tools available on the OPC Developer Portal to enable you to build your application. Before you dive in to your application development we suggest you read the following reference material to help you understand the concepts and principles of developing an Application on OPC:
Of course, we have much more reference material to help you on your journey, please feel free to look around our site using the navigation to the left of this page. Here we are going to explain how you will need to use the Developer Portal during each step of your application build.
The Developer portal has been tested on the latest versions of Chrome and Firefox. The portal might not provide you with the best experience and might have some issues on other browsers.
Step 1 - Create your Application
At this stage, all you are creating is the name and description of your application.
Assuming you have not logged on before, you will be presented with the ‘My Applications’ page and it will not have any applications listed on it:
Click on ‘+ CREATE NEW APPLICATION’
In the free text fields, enter the Application Name you wish to use, as well as a description of the application you intend to build. Click on ‘create’ and confirmation will be received that the new details have been saved. On returning to the ‘My Applications’ page, you will see that your new Application name is listed.
Step 2 - Download a Featured Model
From ‘My Applications’ click on the application name you have just created. This will automatically redirect you to the ‘Application Details’ page, where functionality will be available to manage your applications.
At this stage, you will need to view our featured Payment Models.
You will need to use one of these as the basis of your application build
Hit the link to download the model. This will give you access to the API that you can use to build your application.
As this guide is geared specifically towards using the Developer Portal, we are not going to explain the PAML model and related concepts here - it is expected that you have already read and understood the key OPC concepts that are detailed on the Developer Zone.
If you need a refresher, then please refer to step 1 in the Building a Payment Application guide.
Once you have downloaded the PAML model from the Portal, you will be able to update the following based on the needs of your application:
- Profile and Instance cardinality
- Profile or Instance attributes
- Add new attributes not currently defined in the Paylet definition
- Add constraints for each Paylet type
Let's take a quick look at some examples of the things you can change or add, that will impact how your application works:
1) I want to limit the value of a single transfer of funds to no more than 500 GBP > simply add a constraint on the transfer paylet to set 500 GBP as the maximum allowed value
2) I want to be able to create managed card instances using different managed card profiles (e.g. one that enables multi-spend and another that is limited to single-spend only > make sure that the managed card profile has a cardinality of more than one
Again, we are not showing PAML in this guide as the changes would happen outside of the Developer Portal (while you are working on them).
Step 3 - Build your Compliant Payment Application
If you have made amendments amendments to the PAML model you will need to upload the model using the portal to ensure it is compliant with all required financial rules and regulations.
For example, you must ensure that if there is a method in the model to move funds into a wallet/account, then there must also be a method to withdraw funds from the wallet.
OPC will also check that the Paylet types and cardinalities are compatible with the core system. At runtime, constraints set in the PAML can be maintained by the compliance sub-system e.g. raise an alert when a limit is reached.
Step 4 - Create your Application Logic and UI
There is now nothing stopping you developing your application locally, building on the logic based on API methods you have downloaded.
We have some optional tools that are available to assist your development. To find out about how you can use these, check out the following documents:
Step 5 - Upload your Application Artefact and Test it!
Ok, so now you have completed the build of your application, it’s time to use the portal to upload the application artefact (PAML) and start testing it.
From the ‘Manage Applications’ section on the ‘Application Details’ page, select the ‘Upload’ link. You will be redirected to the ‘Upload Application’ page:
You will need to enter the version number of the application you are uploading (to keep track of new releases and updates made to the Application) as well as comments that support the reason for the upload (e.g. due to an amendment). You will also need to name the file path from where it will be uploaded from. Note that the application name specified in the PAML file should be the same as the name of your created application. Otherwise the process of uplading the PAML file fails.
Please note the version number has two parts – this is to denote the difference between a major and minor change. Typically, the major part of the version is incremented when the impact on the users of the Application is substantial (e.g. a change to the API). The minor would be used to indicate changes to the UI or a release of a new minor feature.
By selecting ‘upload’, your artefact will again be checked for compliance to all required regulations. Once your application has been successfully validated, you will gain access to a sandbox environment where you can test the features are performing as expected.
The OPC Sandbox is the environment that you can use to create, view and manage a Programme for testing purposes. As a developer, you can create a Programme with one or more Corporate Identity instances and check that the Application can manage instruments for such Corporate Identities.
For information on using the Sandbox, refer to the guide available on the Developer Zone.
Step 6 - Submit to the Application Store
After the successful conclusion of Application testing, you can request the Application to be approved by the OPC administrator. If approved the application will be made available in the Appstore.
To request approval, navigate to the ‘Manage’ section from the ‘Application Details’ page.
You will see the version you are about to send for approval currently has a status of ‘Draft’.
Select the ‘Request Approval’ link.
On returning to the ‘Application Details’ page, you will see that the version of your Application has changed status from ‘Draft’ to ‘Pending Approval’.
When an OPC Administrator has approved your Application, you will see that that status of your Application changes to ‘Approved’:
Once approved, your Application will be added to the Appstore and Programme Managers can then create Programmes using the Application.
Just a couple of things to note:
- You can only have one major version of the Application that is in Pending Approval state
- There can only be one major version of the Application that is in Approved state and Active in the Appstore