api-streetcred-custodian v1.0.1

api-streetcred-custodian

Angular module to connect to the Streetcred.Id Custodian API.

Installation

npm install api-streetcred-custodian --save

General usage

In your Angular project:

First extend your src/environments/*.ts files by adding the corresponding base path:

export const environment = {
  production: false,
  streetcredCustodianApiPath: 'https://api.streetcred.id/custodian/v1',
  streetcredApiKey: 'Bearer <your auth key>',
  streetcredSubsKey: '<your subscription token>'
};

Note: The ApiModule is restricted to being instantiated once app wide. This is to ensure that all services are treated as singletons.

In order to use multiple ApiModules you need to create an alias name when importing the modules in order to avoid naming conflicts:

In the src/app/app.module.ts:

import {
  ApiModule as StreetcredCustodianApiModule,
  BASE_PATH as SC_CUSTODIAN_PATH,
  SC_API_KEY as SC_CUSTODIAN_API_KEY,
  SC_SUBS_KEY as SC_CUSTODIAN_SUBS_KEY
  } from 'api-streetcred-custodian';

import { environment } from '../environments/environment';

@NgModule({
  declarations: [
    AppComponent
  ],
    imports: [
        StreetcredCustodianApiModule,
        // make sure to import the HttpClientModule in the AppModule only,
        // see https://github.com/angular/angular/issues/20575
        HttpClientModule
    ],
    { provide: SC_CUSTODIAN_PATH, useValue: environment.streetcredCustodianApiPath },
    { provide: SC_CUSTODIAN_API_KEY, useValue: environment.streetcredApiKey },
    { provide: SC_CUSTODIAN_SUBS_KEY, useValue: environment.streetcredSubsKey }
  bootstrap: [ AppComponent ]
})
export class AppModule { }

In your components.

import { DefaultApi as StreetcredCustodianDefaultApi } from 'api-streetcred-custodian';

export class AppComponent {
  constructor(private apiGateway: StreetcredCustodianDefaultApi) { }
}