Javascript SDK for api.six.se
// for testing you can get token with:
// Six._internal.authenticateWithCredentials(client_id,client_secreat)
var TOKEN = 'token-authenticated-in-backend'
/* Six.connect(TOKEN,[endpoint]) */
var session = Six.connect(TOKEN)
/* session.subscribe(resource,callbackFn(error,data)) */
var unsubscribe = session.subscribe('/listings/848',function(err,data) {
console.log('data',data,err)
})
Install six-sdk in project
# npm install six-sdk
Require the module as usual:
var Six = require('six-sdk')
var session = Six.connect('token-from-backend')
<html>
<body>
<script type="text/javascript" src="https://cdn.six.se/js/six-sdk/0/six-sdk.js"></script>
<script type="text/javascript">
// the SDK is installed as 'Six' in the global scope
var session = Six.connect('token-from-backend')
</script>
</body>
</html>
When using the SDK from cdn.six.se the SDK is installed as Six in the global scope. If there is a risk that this name will clash with some other var, you can change the name of the global by setting SIX_GLOBAL_NAMESPACE before loading the SDK:
<html>
<body>
<script type="text/javascript">
// install the SDK as VendorSix
window.SIX_GLOBAL_NAMESPACE = 'VendorSix'
</script>
<script type="text/javascript" src="https://cdn.six.se/js/six-sdk/0/six-sdk.js"></script>
<script type="text/javascript">
var session = VendorSix.connect('token-from-backend')
</script>
</body>
</html>
Before using the any of the methods in the SDK you must retrieve an authentication token from api.six.se (see the documentation for the API). This is usually done in some backend system and provided as an global var in the HTML document returned to the browser.
All methods to retrive data from the API is attached to the Session object.
To create a new session object:
var session = Six.connect(TOKEN)
Some of the functionality and analytics in the API requires some additional context (ie userid, entitlement groups etc).
To create a session with additional context:
var session = Six.connect(TOKEN).withContext({userId: '16ef65e39e6114fa6d9510042ad83472c9db756a'})
For more information about session contexts, see the API documentation.
The primary way to retrive data from api is via subscribe(resource,callbackFn)
The subscribe method takes a resource (relative to the API endpoint, ie /markets/SEE not https://api.six.se/v2/markets/SSE) and a callback function.
The callback function will be called anytime there is new data available for the resource from the SDK (some other component have called refresh etc). The callback may be called more than once.
The callback can also first be called with an error object, and later with data.
The callback will be called with the arguments:
unsubscribeFn is also returned from the subscribe call itself
// retrive the reference data for an listing with id 848
var unsubscribeFn = session.subscribe('/listings/848',function(error,listing, unsubscribeFn) {
// this callback can be called more then once
})
Errors returned from the SDK methods is of the same structure as error responses from the API.
{
code: "AJAX_ERROR",
title: "Request to endpoint failed",
description: "The request failed. Check that the endpoint is valid?",
details: {
endpoint: 'https://api.six.se/v2/'
}
}
The SDK caches all resources fetched from the API, and all subscribers for the same resource will receive the same data when new data arrives.This means that multiple components on a page using the same underlying data will be kept in sync.
Data is cached until the session is destroyed (typically the next pageview) or session.clearCache() is called.
To populate the cache with new data, there is a method session.refresh(resource). The API will be called and all subscribers for the resource will have their callbacks called.
session.refresh('/listings/848')
The MIT License (MIT)
Copyright (c) 2016 SIX Financial Information
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
SIX Javascript SDK
The npm package six-sdk receives a total of 3 weekly downloads. As such, six-sdk popularity was classified as not popular.
We found that six-sdk demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
TC39 met in Seattle and advanced 9 JavaScript proposals, including three to Stage 4, introducing new features and enhancements for a future ECMAScript release.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.