Inviting a User for Developer Documentation Only

Rave allows access for our Customer Support team to invite a developer to access our Developer Portal and API documentation without giving them access to your Rave branch, projects or business information.

This is useful when you are working with an external developer, integration partner or IT provider who needs access to Rave's API documentation to build or investigate an integration.

What is Developer Documentation Only access?

When we invite a user to Developer Docs, it creates a Rave login for the developer, but restricts their access to the Developer Portal.

They can view the technical information required to work with the Rave API without being added as a normal user of your Rave account.

What can the developer access?

Once they have accepted their invitation and signed in, they can access the Rave Developer Portal, including:

• Articles – developer and API-related documentation
• API Reference – available Rave API endpoints and their requirements
• API Scopes – the permissions/scopes available through the API
• URLs – relevant API URLs and environments
• OpenAPI Specification – a downloadable specification that can be imported into tools such as Postman or Insomnia

The API Reference allows developers to browse available endpoints across areas such as:

• Branch Financial
• Calendar
• Client Enquiries
• Clients
• Contacts
• Current User
• Project Financial
• Projects
• Timesheets

Selecting an endpoint displays the available URL, parameters, request information and expected responses.

What can't they access?

Developer Documentation Only access is specifically designed for technical documentation.

The developer is not being invited as a standard Rave user and does not receive normal access to areas such as:

• CRM
• Projects
• Financial information
• Scheduling
• Timesheets
• Documents
• Branch Settings
• Other branch or project information

This lets you give your developer the information they need to understand the Rave API without giving them access to your day-to-day Rave data.

API access is separate

Access to the Developer Portal allows the developer to view the documentation.

It does not automatically give them permission to access your branch data through the API. Any API credentials, tokens, scopes or integration permissions required to connect to your Rave account must still be configured separately.

Developer Documentation Only = access to the documentation, not automatic access to your Rave data.

Please email help@ravebuild.co.nz with the Developer email address and your Rave branch name.  You must specify Developer Documentation access only.