Developer Portal - My Connectors
Here we are going to explain how you will need to use the Developer Portal during each step of your connector 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 Connector
At this stage, all you are creating is the name, type and description of your connector.
Assuming you have not created any connectors before, when clicking on the ‘My Connectors’ menu item, you will be presented with the ‘My Connectors’ page and it will not have any connectors listed on it:
Click on ‘+ CREATE NEW CONNECTOR’
In the free text fields, enter the Connector Name you wish to use, a description of the connector you intend to build and select the type of service this connector will be providing. Click on ‘create’ and confirmation will be received that the new details have been saved. On returning to the ‘My Connectors’ page, you will see that your new Connector is listed.
Step 2 - Download SPI Utilities
From ‘My Connectors’ click on the connector name you have just created. This will automatically redirect you to the ‘Connector Details’ page, where functionality will be available to manage your connector. At this stage, you will need to download the SPI utilities.
You will need to use these resources as guidelines to build your connector.
Hit the link to download the available contracts. This will give you access to the SPI contract that you need to build a connector and a simulator contract to build the required simulator.
As this guide is geared specifically towards using the Developer Portal, we are not going to explain the SPI contract and related concepts here.
Step 3 - Upload your Connector Artefact and test it!
Ok, so now you have completed the build of your connector, it’s time to use the portal to upload the connector source code and start testing it. The source code should be uploaded in the form of a zip file. From the ‘Manage’ section on the ‘Connector Details’ page, select the ‘Upload’ link. You will be redirected to the ‘Upload Connector’ page:
You will need to enter the version number of the connector you are uploading (to keep track of new releases and updates made to the Connector) 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.
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 Connector is substantial (e.g. a change to the API). The minor would be used to indicate a release of a new minor feature. By selecting ‘upload’ your artefact will again be verified by the OPC Administrator.
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 which uses the created Connector and test the implemented services by creating managed instruments and performing transactions on a staging environment
For information on using the Sandbox, refer to the guide available on the Developer Zone.
Step 4 - Submit to the Connector Store
After the successful conclusion of Connector testing, you can request the Connector is approved by the OPC Administrator. If approved the Connector will be made available in the Connector Store.
To request approval, navigate to the ‘Manage’ section from the ‘Connector 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 ‘Connector Details’ page, you will see that the version of your Connector has changed status from ‘Draft’ to ‘Pending Approval’.
When an OPC Administrator has approved your Connector, you will see that that status of your Connector changes to ‘Approved’:
Once approved, your Connector will be added to the Connector Store and Service Providers can link to your Connector, while Programme Managers can create Programmes using the Connector. Just a couple of things to note:
- You can only have one major version of the Connector that is in Pending Approval state
- There can only be one major version of the Connector that is in Approved state in the Connector Store.