This guide shows you how to create a new practice and invite users via Vim’s self-service Invitations API. It’s designed for developers and partners who want to automate onboarding directly within their app or workflow.
Why Use the Invitations API?
Vim’s Invitations API allows you to seamlessly create practices, activate users, and manage onboarding through your own platform. This ensures a faster, more integrated experience for your users.
Key benefits include:
- Seamless integration: Automatically provision accounts and practices as part of your app’s workflow.
- Instant onboarding: Practices and users are created and activated in real time.
- Full control: You manage how and when users are invited and onboarded.
Step-by-Step: Create a New Practice
1. Get an Access Token
To authorize your API requests:
- Call the Obtain Access Token endpoint to retrieve your token.
- Include this token in the Authorization header of your requests.
2. Send a Request to the Invitations API
- Use the endpoint to create a new practice and user based on the data you provide.
- The API will automatically generate an account, an organization (practice), and activate the user.
3. Share the Invitation URL
- Upon successful creation, the API returns an invitation URL.
- Send this URL to the user, allowing them to log in and complete the activation process.
Tips for a Smooth Integration
- Use our Postman collection to test and explore the API. You can import it directly into your workspace.
- Connect the API to your registration flow to automate onboarding without extra steps for your users.
- Keep the user experience clean and timely by sending the invitation link right after practice creation.
Resources