Getting started with our B2B services
This Getting Started Guide is intended to provide you with easy to understand information about the B2B services and how you start developing and using them.
About our B2B services
We currently have 1 SOAP API that you can use in our Developer Portal. This API is for recording Sales Orders for IC-ENC. This Getting Started Guide provides you with details about our SOAP service, and the process you will need to follow to start using it.
About our SOAP API
To start using our API you need to first signup to this IC-ENC Developer Portal, and then once you have signed up you need to request access.
We currently have 1 SOAP API that is deployed to 2 environments which require 2 different subscriptions:
IC-ENC Sales Interface Service-PREPROD – Training API for developing against and making test API requests
IC-ENC Sales Interface Service-PROD – Live API. All requests will be processed and charged for.
Getting started with the SOAP B2B service
Below are details of the process you will need to go through to develop and start using our SOAP B2B services.
1. Request Access to the IC-ENC Developer Portal
You will need to send a request to therenc@ic-enc.org with your business case for using our APIs. This request may take up to 7 working days to process.
2. Receive and accept your invitation to join our IC-ENC Developer Portal
When we have processed your request, you will receive an email inviting you to join our IC-ENC Developer Portal. This is sent from apimgmt-noreply@mail.windowsazure.com so please ensure that you can receive emails from this address.
Click on the link in the email to activate your account. This will open the IC-ENC Developer Portal in a new web page where you will need to provide a password for your account.
Once you have done this, you will need to contact therenc@ic-enc.org to notify us that you have now activated your IC-ENC Developer Portal account. Following this we can set you up with subscription to use our API. This may take up to five days to set up.
3. Receive subscription for our Training API
Our IC-ENC Developer Portal provides you with technical documentation and support materials to help you develop your own SOAP API B2B solution. Having a subscription to the IC-ENC Sales Interface Service-PREPROD API Management product gives you a Subscription Key which enables you to use the APIs in this environment.
You will receive email notification when we have set you up with an IC-ENC Developer Portal subscription to our Training environment. This is sent from apimgmt-noreply@mail.windowsazure.com.
4. Develop your SOAP B2B service
Once we have set you up with a PREPROD subscription, you can begin developing your own B2B solutions. To help you do this we have provided the following documentation on our IC-ENC Developer Portal:
5. Let us know when you have finished developing and want to go live
When you have finished developing your SOAP B2B solution you will need to let us know so that we can give you access to the Live service. Please notify us by contacting therenc@ic-enc.org. We will then go through some quality checks before enabling your access to the APIs in Live. This process may take up to five days to complete.
6. Receive details about our Live Subscription so that you can go live
Once we have checked your API calls in our Training environment, we will provide you with an IC-ENC Developer Portal subscription to our Live Sales Interface API. Access to this enables you to point your B2B solution at our live API and create orders.
You will receive email notification when we have set you up with a IC-ENC Sales Interface Service-PROD subscription. This is sent from apimgmt-noreply@mail.windowsazure.com.
When you have received this notification, you will need to make some configuration changes to your B2B solution to be able to use the live Sales Interface Service by using the Live subscription keys. Once you have made these configuration changes you can start using our Live SOAP API.
Future Services
We intend to create a REST API in the future and more information will be published when that is available.