- Our website (www.rebilly.com) is powered by Redocly Revel.
- Our API reference is powered by Redocly Realm.
TBD: Add Redocly validation status badge.
To view the full Rebilly API reference documentation, go to https://www.rebilly.com/catalog/all/.
The full Rebilly API reference documentation has over 500 operations. This is likely more than you may need to implement your use cases. If you would like to implement a particular use case, contact Rebilly for guidance and feedback on the best API operations to use for the task.
To integrate Rebilly, and learn about related resources and concepts, see Get started.
If you use VS Code, use the Redocly VS Code extension to edit this repo and get inline lint feedback and previews.
- Install Node JS (version 14 or more recent)
- Clone repo and run
npm ciin the repo root
This process describes how to start a development server docs preview for the Rebilly API docs. Changes made to the API specification while the development server is running are immediately displayed in the docs preview.
Rebilly uses Redocly to generate, manage, and preview API docs.
- In a terminal, install the Redocly CLI.
Use this command to install the package globally on your machine:npm install @redocly/cli -g - Sign in or create a Redocly account.
If you are a Rebilly employee, sign in using SSO and your Rebilly email address. - In Redocly, in the top right of the screen, press your name, then press My profile.
- In the Personal API keys section, press Add API key.
- Enter an API key name, then press Save.
- Copy the API key.
- In a terminal, execute the following command:
npx @redocly/cli login. - When prompted, paste your API key.
- Execute one of the following commands to start a development server docs preview:
- Core API docs:
npx @redocly/cli preview-docs core@latest - All API docs:
npx @redocly/cli preview-docs all@latest
- Core API docs:
- In a web browser, open the preview server URL that is displayed in the terminal.
Run npm run build:latest to bundle the definitions into a single file in the catalog folder.
Run npx @redocly/cli lint to validate the definitions.
