openTdataCH / ojp-js

OJP Javascript SDK

OJP Javascript SDK

The OJP Javascript SDK is a Javascript/Typescript package used for communication with OJP APIs.

See Reference and examples for usage.

Resources

• OJP Demo App: https://opentdatach.github.io/ojp-demo-app/ - web application this SDK
• CHANGELOG for latest changes
• npm ojp-sdk package: https://www.npmjs.com/package/ojp-sdk

Install

Two versions of the OJP APIs can be used:

• OJP 1.0 - still supported by ojp-js SDK but might receive less support in the future
• OJP 2.0 - next version, see VDVde/OJP specs

OJP 1.0

The main branch of ojp-js repo is using OJP 1.0 APIs. The releases are published to npmjs.com as ojp-sdk packages.

• include the ojp-sdk package in the ./package.json dependencies of your project

  "dependencies": {
    "ojp-sdk": "0.9.33"
  }

OJP 2.0

The ojp-v2 branch is used for developing OJP 2.0 bindings,

• include the #ojp-v2 branch

  "dependencies": {
    "ojp-sdk": "git+https://github.com/openTdataCH/ojp-js.git#feature/ojp-v2"
  }

Usage

• update project dependencies

$ npm install

• include OJP SDK in the Typescript / Javascript code

import * as OJP from 'ojp-sdk'

• for more details check:
  • this repo reference
  • this repo examples
  • OJP Demo App source code

License

The project is released under a MIT license.

Copyright (c) 2021 - 2024 Open Data Platform Mobility Switzerland - opentransportdata.swiss.