https://github.com/ringcentral/engage-digital-api-docs
API Documentation for RingCX
https://github.com/ringcentral/engage-digital-api-docs
documentation ringcx
Last synced: 6 months ago
JSON representation
API Documentation for RingCX
- Host: GitHub
- URL: https://github.com/ringcentral/engage-digital-api-docs
- Owner: ringcentral
- License: mit
- Created: 2019-07-11T05:12:11.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-06T14:40:52.000Z (over 1 year ago)
- Last Synced: 2025-03-06T15:35:11.333Z (over 1 year ago)
- Topics: documentation, ringcx
- Language: HTML
- Homepage:
- Size: 18.3 MB
- Stars: 5
- Watchers: 17
- Forks: 30
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RingCentral Engage API Docs
[![Build Status][specs-status-svg]][specs-status-url]
[![Docs Status][docs-status-svg]][docs-status-url]
[![Docs][docs-svg]][docs-url]
This repository is the home of the RingCentral Engage Developer Guide: a collection of materials, and documentation to help educate developers on how to build on top of the RingCentral Engage platform.
Visit a [live preview][docs-url] of https://developers.ringcentral.com/engage/digital/guide
## Contributing
If you would like to contribute to the RingCentral documentation effort, fork this repository, make your desired edits and contributions, and issue a pull request accordingly.
### Running ReadTheDocs Locally
```
% git clone https://github.com/ringcentral/engage-digital-api-docs.git
% cd engage-digital-api-docs
% pip install mkdocs mkdocs-ringcentral mdx_include
% python3 -m mkdocs serve -a localhost:8000
```
Or with docker:
```
./preview.sh
```
Then you should be able to load http://localhost:8000 to view the documentation.
### Generating OpenAPI doc
Go check [specs/README.md](specs/README.md)
### Testing OpenAPI Specs
This repo holds OpenAPI specs for Engage Digital.
You can preview the latest version of the swagger spec on the [swagger preview][swagger-preview]
For each commit, tests are run on Travis CI to verify that the OpenAPI 3.0 specs validate.
* Engage Digital Spec: [specs/digital/engage-digital_openapi3.yaml](specs/engage-digital_openapi3.yaml)
* Tests: [specs_test.go](specs_test.go)
You can verify the specs localy with the following if you have [Go installed](https://golang.org/).
```
% git clone https://github.com/ringcentral/ringcentral-api-docs.git
% cd ringcentral-api-docs
% go test -v ./...
```
If you wish to change the specs being tested edit the [specs_test.go](specs_test.go) file.
[specs-status-svg]: https://github.com/ringcentral/engage-digital-api-docs/workflows/spec%20build/badge.svg?branch=master
[specs-status-url]: https://github.com/ringcentral/engage-digital-api-docs/actions
[docs-status-svg]: https://readthedocs.org/projects/engage-digital-api-docs/badge/?version=latest
[docs-status-url]: https://readthedocs.org/projects/engage-digital-api-docs/builds/
[docs-svg]: https://img.shields.io/badge/docs-readthedocs-blue.svg
[docs-url]: https://engage-digital-api-docs.readthedocs.io/en/latest/
[swagger-preview]: https://ringcentral.github.io/engage-digital-api-docs/digital/