@signalwire/web-api
TypeScript icon, indicating that this package has built-in type declarations

3.1.2 • Public • Published

@signalwire/web-api

SignalWire Web-API SDK

Build Status NPM

The @signalwire/web-api SDK enables Node.js developers to connect and use SignalWire's Web APIs within their own Node.js code. Our WebAPI SDK allows developers to build or add robust and innovative communication services to their applications.

Getting Started

Read the implementation documentation, guides and API Reference at the official WebAPI SDK Documentation site.


Contributing

SignalWire WebAPI SDK is open source and maintained by the SignalWire team, but we are very grateful for everyone who has contributed and assisted so far.

If you'd like to contribute, feel free to visit our Slack channel and read our developer section to get the code running in your local environment.

Developers

The WebAPI SDK is a package inside the signalwire-js monorepo. To setup the dev environment follow these steps:

  1. Download the installer for the LTS version of RealTime. This is the best way to also install npm.
  2. Fork the signalwire-js repository and clone it.
  3. Create a new branch from main for your change.
  4. Run npm install to install global dependencies.
  5. Navigate into the web-api directory with cd packages/web-api.
  6. Make changes!

Versioning

SignalWire WebAPI SDK follows Semantic Versioning 2.0 as defined at http://semver.org.

License

@signalwire/web-api is copyright © 2018-2023 SignalWire. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

Package Sidebar

Install

npm i @signalwire/web-api

Weekly Downloads

493

Version

3.1.2

License

MIT

Unpacked Size

860 kB

Total Files

329

Last publish

Collaborators

  • jpsantosbhz
  • iammaransari
  • littorwired
  • crienzo
  • chris.clement
  • edlucas
  • bryanrite
  • danieleds
  • startledmarmot