Integration-services NPM

integration_services_api_documentation

IntegrationServicesApiDocumentation - JavaScript client for integration_services_api_documentation This is the API documentation for the Integration Services. Have a look at the repository for examples at Github. For further information on the Audit Trail GW API have a look at Audit Trail API and head to SSI Bridge for information about the SSI Bridge.
This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.0
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install integration_services_api_documentation --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var IntegrationServicesApiDocumentation = require('integration_services_api_documentation');
var defaultClient = IntegrationServicesApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['api-key'] = "Token"

var api = new IntegrationServicesApiDocumentation.AuthenticationApi()
var identityId = new IntegrationServicesApiDocumentation.IdentityIdSchema(); // {IdentityIdSchema} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.authenticationProveOwnershipIdentityIdGet(identityId, callback);

Documentation for API Endpoints

All URIs are relative to https://ensuresec.solutions.iota.org/api/v0.1

Class	Method	HTTP request	Description
IntegrationServicesApiDocumentation.AuthenticationApi	authenticationProveOwnershipIdentityIdGet	GET /authentication/prove-ownership/{identityId}	Request a nonce which must be signed by the private key
IntegrationServicesApiDocumentation.AuthenticationApi	authenticationProveOwnershipIdentityIdPost	POST /authentication/prove-ownership/{identityId}	Get an authentication token by signing a nonce
IntegrationServicesApiDocumentation.ChannelInfoApi	channelInfoChannelChannelAddressDelete	DELETE /channel-info/channel/{channelAddress}	Delete information of a channel
IntegrationServicesApiDocumentation.ChannelInfoApi	channelInfoChannelChannelAddressGet	GET /channel-info/channel/{channelAddress}	Get information about a channel
IntegrationServicesApiDocumentation.ChannelInfoApi	channelInfoChannelPost	POST /channel-info/channel	Add an existing channel into the database
IntegrationServicesApiDocumentation.ChannelInfoApi	channelInfoChannelPut	PUT /channel-info/channel	Update channel information
IntegrationServicesApiDocumentation.ChannelInfoApi	channelInfoSearchGet	GET /channel-info/search	Search for a channel
IntegrationServicesApiDocumentation.ChannelsApi	channelsCreatePost	POST /channels/create	Create a new channel
IntegrationServicesApiDocumentation.ChannelsApi	channelsHistoryChannelAddressGet	GET /channels/history/{channelAddress}	Get the history of a channel.
IntegrationServicesApiDocumentation.ChannelsApi	channelsLogsChannelAddressGet	GET /channels/logs/{channelAddress}	Get data from the channel
IntegrationServicesApiDocumentation.ChannelsApi	channelsLogsChannelAddressPost	POST /channels/logs/{channelAddress}	Write data to a channel
IntegrationServicesApiDocumentation.ChannelsApi	channelsReImportChannelAddressPost	POST /channels/re-import/{channelAddress}	Re import the data from the tangle into the database.
IntegrationServicesApiDocumentation.ChannelsApi	channelsValidateChannelAddressPost	POST /channels/validate/{channelAddress}	Validates channel data by comparing the log of each link with the data on the tangle.
IntegrationServicesApiDocumentation.IdentitiesApi	identitiesCreatePost	POST /identities/create	Create a new decentralized digital identity (DID)
IntegrationServicesApiDocumentation.IdentitiesApi	identitiesIdentityIdentityIdDelete	DELETE /identities/identity/{identityId}	Removes an identity from the Bridge
IntegrationServicesApiDocumentation.IdentitiesApi	identitiesIdentityIdentityIdGet	GET /identities/identity/{identityId}	Get information about a specific identity
IntegrationServicesApiDocumentation.IdentitiesApi	identitiesIdentityPost	POST /identities/identity	Register an existing identity into the Bridge
IntegrationServicesApiDocumentation.IdentitiesApi	identitiesIdentityPut	PUT /identities/identity	Update claim of a registered identity
IntegrationServicesApiDocumentation.IdentitiesApi	identitiesSearchGet	GET /identities/search	Search for identities
IntegrationServicesApiDocumentation.ServerInfoApi	infoGet	GET /info	Get information about the server
IntegrationServicesApiDocumentation.SubscriptionsApi	subscriptionsAuthorizeChannelAddressPost	POST /subscriptions/authorize/{channelAddress}	Authorize a subscription to a channel
IntegrationServicesApiDocumentation.SubscriptionsApi	subscriptionsChannelAddressGet	GET /subscriptions/{channelAddress}	Get all subscriptions of a channel.
IntegrationServicesApiDocumentation.SubscriptionsApi	subscriptionsChannelAddressIdentityIdDelete	DELETE /subscriptions/{channelAddress}/{identityId}	Deletes subscription
IntegrationServicesApiDocumentation.SubscriptionsApi	subscriptionsChannelAddressIdentityIdGet	GET /subscriptions/{channelAddress}/{identityId}	Get a subscription by identity id.
IntegrationServicesApiDocumentation.SubscriptionsApi	subscriptionsChannelAddressIdentityIdPost	POST /subscriptions/{channelAddress}/{identityId}	Adds an existing subscription
IntegrationServicesApiDocumentation.SubscriptionsApi	subscriptionsChannelAddressIdentityIdPut	PUT /subscriptions/{channelAddress}/{identityId}	Updates an existing subscription
IntegrationServicesApiDocumentation.SubscriptionsApi	subscriptionsRequestChannelAddressPost	POST /subscriptions/request/{channelAddress}	Request subscription to a channel
IntegrationServicesApiDocumentation.SubscriptionsApi	subscriptionsRevokeChannelAddressPost	POST /subscriptions/revoke/{channelAddress}	Revoke subscription to a channel.
IntegrationServicesApiDocumentation.VerificationApi	verificationCheckCredentialPost	POST /verification/check-credential	Check the verifiable credential of an identity
IntegrationServicesApiDocumentation.VerificationApi	verificationCreateCredentialPost	POST /verification/create-credential	Verify the authenticity of an identity and issue a credential
IntegrationServicesApiDocumentation.VerificationApi	verificationLatestDocumentIdentityIdGet	GET /verification/latest-document/{identityId}	Get the latest version of an identity document (DID)
IntegrationServicesApiDocumentation.VerificationApi	verificationRevokeCredentialPost	POST /verification/revoke-credential	Revoke one specific verifiable credential of an identity
IntegrationServicesApiDocumentation.VerificationApi	verificationTrustedRootsGet	GET /verification/trusted-roots	Returns a list of Trusted Root identity identifiers (DIDs)
IntegrationServicesApiDocumentation.VerificationApi	verificationTrustedRootsPost	POST /verification/trusted-roots	Adds Trusted Root identity identifiers (DIDs)
IntegrationServicesApiDocumentation.VerificationApi	verificationTrustedRootsTrustedRootIdDelete	DELETE /verification/trusted-roots/{trustedRootId}	Remove Trusted Root identity identifiers (DIDs)

Documentation for Models

Documentation for Authorization

ApiKey

Type: API key
API key parameter name: api-key
Location: URL query string

BearerAuth

@babel/cli superagent

@infinitebrahmanuniverse/nolb-integ @everything-registry/sub-chunk-1920 @zalastax/nolb-integ

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago