This article discusses how to set up your Filevine Org for integrations using Filevine API v2. Setting up includes choosing your user and generating API credentials.
API integrations automate Filevine functions by connecting different programs to one another. Filevine API v2 can be used with Zapier, making the process easier.
Choosing Your User
API integrations automate user actions, meaning that one user in Filevine will “perform” the actions that the API is automating. For example, if an API integration is set up to automatically post a note in Filevine, it will post that note through whichever user in Filevine is connected to the API.
Because of the way user actions are automated, Filevine recommends creating a dummy user, like one named “Zapier,” to connect with the API, rather than using a real user. This will help prevent confusion between the integration’s automated actions and the actions of a real user. A dummy user will not be counted against your Filevine contract. If you are using a dummy user, make a note of the username and password for that dummy user. They will be used to log into the Filevine Portal in the next step.
A dummy user should be used in most instances. However, if you will be creating integrations connected with only one user, like integrations dependent on a user’s personal email, it may be more useful for that user to connect with the API.
The user connected with the API needs to be a collaborator on any projects it needs to manipulate. Your chosen user should have collaborator permissions set up for current projects as well as future projects. For steps on how to set up these permissions, read the “Set Up Permission for Existing Projects” and the “Set Up Rules for New Projects” sections of this article.
Generating the API Key
Once you have determined which user(s) will need API keys, you should contact Filevine to be granted access to the Filevine Portal site where the API credentials will be generated. Contact Filevineby emailing email@example.com.
When emailing, include the email address of the user that will be connected via API and the name of the Org that user is in. Once you receive a response granting you access to the portal site, follow the steps below to generate an API key:
- Go to the Filevine Portal. Input the username and password of the user who will be using the API key. If you are using a dummy user, this means that you will enter the username and password created for the dummy user, rather than your own. (This step can also be done when authenticating your connection with Filevine in Zapier.)
- Select “Create new key.” Once you’ve logged into the portal site, select “Keys” from the site’s lefthand menu. Under “My API Keys,” select the blue “Create new key” button.
- Select all scopes. Fill in the purpose of this key (“Zapier,” for example) and make sure to check the box by every scope.
- Create and save. Once all scopes have been selected, click the “Create” button. The API key and secret will generate. Make sure to scroll to the bottom of the screen and select “Save” so that you can return to this key.
Your API secret enables unmitigated access to your firm’s data. Treat your API secret like a password:
- Store it securely.
- Don't share it with anyone outside of your company.
- Don't put it in any code on your website or in a URL that someone could find.
The API key and secret will be used to authorize the integration with Zapier or whatever program you are integrating with. Once the key has been generated and saved, it can be accessed later by simply logging back into the portal.