OJP Javascript SDK

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

Current Development Status

Javascript SDK branches

| Branch | NPM | Demo App | Description | |-|-|-|-| | ojp-js#ojp-sdk-legacy | ojp-sdk-legacy | PROD - OJP 2.0BETA - OJP 1.0 | original SDK, contains dual code for OJP 1.0,2.0 | | ojp-js#ojp-sdk-next | ojp-sdk-next - temporarely, long-term will be published under ojp-sdk | under development | new SDK code with models derived from XSD schema, this will be the main development reference for OJP JS SDK |

Code / Demo App Implementation

| Code Place | LIR | SER | TR | TIR | FR | TRR | Comments | | - | - | - | - | - | - | - | - | | ojp-sdk-legacy (legacy SDK) | :white_check_mark: | :white_check_mark: | :white_check_mark: | - | - | - | TRR is only available for OJP v2.0 | | ojp-sdk-next (new SDK) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | DemoApp Beta | legacy | legacy | legacy | ojp-sdk-next | ojp-sdk-next | ojp-sdk-next | legacy is the old SDK (OJP v1 and v2, see above) |

• LIR - LocationInformationRequest
• SER - StopEventRequest
• TR - TripRequest
• TIR - TripInfoRequest
• FR - FareRequest
• TRR - TripRefineRequest

Resources

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

Usage

Note: 26.Mar - a different package name is used for test purpose: ojp-sdk-next. This package will replace the current ojp-sdk package.

• include ojp-sdk-next, ojp-shared-types packages in the ./package.json dependencies of the project

  "dependencies": {
    "ojp-shared-types": "0.1.1",
    "ojp-sdk-next": "0.21.1",
  }

• get an API key from opentransportdata.swiss API manager

• use the SDK, see also playground.component.ts in examples

import * as OJP from 'ojp-sdk-next';

// ...

// declare the stage config, PROD example below
const httpConfig: OJP.HTTPConfig = {
  url: 'https://api.opentransportdata.swiss/ojp20',
  authToken: 'TOKEN_FROM_opentransportdata.swiss',
};

// define a requestorRef that describes the client
const requestorRef = 'MyExampleTransportApp.v1';

// create the SDK
const language = 'de'; // de, fr, it, en
const ojpSDK = OJP.SDK.create(requestorRef, httpConfig, language);

// build LIR by Name
const searchTerm = 'Bern';
const request1 = ojpSDK.requests.LocationInformationRequest.initWithLocationName('Bern');

// build LIR by StopRef
const stopRef = '8507000'; // Bern
const request2 = ojpSDK.requests.LocationInformationRequest.initWithPlaceRef(stopRef);

// build LIR by BBOX
// these are equivalent
let bbox: string | number[] = '7.433259,46.937798,7.475252,46.954805';
bbox = [7.433259, 46.937798, 7.475252, 46.954805];

const request3 =  ojpSDK.requests.LocationInformationRequest.initWithBBOX(bbox, ['stop']);

// change XML payload if needed
request1.payload.initialInput ...

// fetch the results
async myMethod() {
  // ...
  const response = await request1.fetchResponse(ojpSDK);

  if (!response.ok) {
    // handle error
    console.log(response.error);
    return;
  }

  // do something with the value
  const placeResults = response.value.placeResult ?? [];
  placeResults.forEach(placeResult => {
    console.log(placeResult.place.name);
  });
}

TBA

• update docs

License

The project is released under a MIT license.

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