Welcome to the RoxWrite Documentation for Platform Partners.
Refer to the documentation below to use the Roxwrite API.
Environments
Note that we have two separate environments — Sandbox for testing, and Production for regular usage. You can access them below.
Sandbox
- UI: demo.roxwrite.com
- API: api.demo.roxwrite.com
Production
- UI: app.roxwrite.com
- API: api.app.roxwrite.com
What you'll need
To get started, you will need (we provide these for both Sandbox and Production):
- User credentials
- API key
Authentication
You will need an API key to integrate other applications (e.g. Salesforce) with Roxwrite. Please contact support if you don't have your User credentials or API key.
Once you have the API key, follow these steps:
- Use the Login into App to get a bearer token. This token should be sent in the header in your API calls to Roxwrite.
- Use the Get currently logged in user's info endpoint with the bearer token to get your client-id. This is the identifier for the logged in user.
- The client-id and the bearer token should be put in the header for every request to the endpoints listed in Roxwrite API integration