https://github.com/miyajan/garoon-soap

Garoon soap api client for Node and Browser
https://github.com/miyajan/garoon-soap

Last synced: 4 days ago
JSON representation

Garoon soap api client for Node and Browser

• Host: GitHub
• URL: https://github.com/miyajan/garoon-soap
• Owner: miyajan
• License: mit
• Created: 2017-01-21T13:07:56.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2020-11-03T14:46:47.000Z (about 4 years ago)
• Last Synced: 2024-04-26T01:20:32.425Z (7 months ago)
• Language: TypeScript
• Size: 1.02 MB
• Stars: 10
• Watchers: 2
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# garoon-soap

Garoon SOAP API client library for JavaScript applications (both on web browser and Node.js).

[![npm version](https://img.shields.io/npm/v/garoon-soap.svg)](https://www.npmjs.com/package/garoon-soap)

[![npm downloads](https://img.shields.io/npm/dm/garoon-soap.svg)](https://www.npmjs.com/package/garoon-soap)

![License](https://img.shields.io/npm/l/garoon-soap.svg)

## Overview

garoon-soap is an isomorphic JavaScript library utilizing Garoon SOAP API. It works both in the browser and Node.js.

With this library, you can use Garoon SOAP API without considering XML which is too hard for developers to handle.

[Supported APIs](https://developer.cybozu.io/hc/ja/categories/200157760-Garoon-API)

## Setup

### Node.js

Install ```garoon-soap``` via npm.

```

npm install garoon-soap

```

Require ```garoon-soap``` in your Node.js code.

```

const GaroonSoap = require('garoon-soap');

const garoon = new GaroonSoap('https://example.cybozu.com/g/', 'username', 'password');

// example

const start = new Date();

const end = new Date();

end.setDate(start.getDate() + 1);

garoon.schedule.getEvents(start, end).then(events => {

    console.log(events);

});

```

### Web Browser

Download ```garoon-soap.min.js``` from [Releases](https://github.com/miyajan/garoon-soap/releases).

Load it by ``````.

Then, you can use ```GaroonSoap``` class in your JavaScript.

```

// You can use session authorization if you have already logged-in to Garoon.

const garoon = new GaroonSoap('https://example.cybozu.com/g/');

// example

const start = new Date();

const end = new Date();

end.setDate(start.getDate() + 1);

garoon.schedule.getEvents(start, end).then(events => {

    console.log(events);

});

```

## License

MIT

## Author

[miyajan](https://github.com/miyajan): Jumpei Miyata [email protected]

## Disclaimer

This OSS is my own personal work and does not have any relationship with Cybozu Inc. or any other organization which I belong to.