Enferno.StormApiClient 2.5.2-beta2

• .NETFramework 4.5

  • Enferno.Public (>= 2.3.1)

Please see release notes for 2.0.0 for details if you are upgrading from <= v1.8.x.
Note that the 1.8.x branch will no longer be updated.

Also note the breaking change in Enferno.Public 2.3.0.

Make sure to use our new addresses:
Stage/Lab: https://api.lab.storm.io/api/1.1
Production: https://api.storm.io/api/1.1

Breaking changes in 2.5.0

Using Oauth2 instead of certificates.

What's new?

To use OAUTH2 you need 4 settings.

* Client Id
* Client Secret
* Scope
* Application Id.

- Client Id and Secret is created in Storm Admin. At https://admin.storm.io/admin/settings/user under the OAUTH tab.

- Scope tells us if you are trying to access lab/qa/production data. (This will not point the request to a specific environment, it will only say that you gives the client access to the specified environment.)
Existing scopes: lab / qa / production

- Application Id is the application that you want to use.


To read these settings we use the Interface IOAuth2CredentialsProvider registed with DI.
You can create your own if you want, or you can use our OAuth2AppSettingsCredentialsProvider.


Our OAuth2AppSettingsCredentialsProvider will read the settings from the appsettings in web.config.

The AccessClient will for each request check IOAuth2CredentialsProvider.ApplicationId to see what application it should use.
You can override this by using the applicationId parameter when creating an AccessClient.
So with help of these(parameter in AccessClient,your own IOAuth2CredentialsProvider) you can use multiple applications.

*** If you are using Enferno.Web.StormUtils with multiple applications you must create your own IOAuth2CredentialsProvider. ***





** Checklist of changes that may have to be updated after an upgrade.

- Register IOAuth2CredentialsProvider to DI
Ex: in web.config
<register type="IOAuth2CredentialsProvider" mapTo="OAuth2AppSettingsCredentialsProvider">
<lifetime type="singleton" />
</register>

Ex: via code:
IoC.RegisterType<IOAuth2CredentialsProvider, OAuth2AppSettingsCredentialsProvider="">
();


- If you are using OAuth2AppSettingsCredentialsProvider add these appsettings to your web.config

appSettings:

API.OAuth2.ClientId     : clientId guid.
API.OAuth2.ClientSecret : clientsecret guid.
API.OAuth2.Scope        : lab/qa/production
API.ApplicationId       : applicationId you want to use


- Update Endpoints in web.config

attributes under client.endpoint:
remove: behaviorConfiguration
change: bindingConfiguration from SOAP -> Auth2-SOAP

add a new binding under bindings.wsHttpBinding with name "Auth2-SOAP".

<binding name="Auth2-SOAP" maxReceivedMessageSize="10000000" >
<security mode="Transport">
<transport clientCredentialType="None" proxyCredentialType="None" realm="" />
<message clientCredentialType="None"  />
</security>
</binding>



Remove SOAP under bindings.wsHttpBinding.

Remove endpointBehaviors: CertificateBehavior.

- If you are using Enferno.Web.StormUtils with multiple applications you must create your own IOAuth2CredentialsProvider.


     Regards,
     The Storm API Team