MyFrankCrum Client API: How to set up your API Access

Step-by-step instructions on how to set up your account and request access to the API.

Fill out the Security Admin API Form

Once you’re ready to get setup with the FrankCrum API, your Client Experience Account Manager will share the API Security Request Form to fill out the approved users, review our disclaimer, and sign for agreement.

Register Your User Account

1. Access the client portal: https://developer.frankcrum.com/
2. Select “Login” at the top.
   
   
3. Select “Register Here”
   
   
4. Add the required information to the Registration screen and select “Request Access”
   Note: We do allow for group emails, but please be mindful of security concerns for your company and employee data.
   
   
5. Once your request has been reviewed and approved by a team member (about 1-2 days), based on the information in the API Security Request Form, you will receive an email with a link to create your password.
   Note: Check the spam folder if not received within the turn-around time.
   
   
6. Set up your password following the security standards.
   
   
   
7. Once the password is set, you will be taken back to the portal. Select the API tab in the top menu.
   
   
8. Select the User Services (fc-user-services-exp-api)
   
   
9. Select “Request Access”
   Note: If you are not logged in, you will not be able to select this option.
   
   
10. Fill in the details for the application you will be using with this API.
    • API Instance is the environment you wish to connect to.
    • Client Application needs to be setup with the app you will be using the API with. This can be generic if you do not want different keys for different applications.
    
    
    
    • SLA Tier is the mechanism we use to throttle data requests.
    • Select “Request Access” to submit your request.
    
    
11. Once submitted you will see your Client ID and Secret Key. These are accessible through the portal, but please save them locally.
12. Once your application request has been reviewed and approved internally, your Client ID will be connected to the Project IDs associated with your company.
    Note: You will not receive confirmation once this is completed but can expect a 1-2 day turn-around.
13. Now that your account has been registered and your application information has been connected to your data, you may use your Client ID and Secret Key with applications such as Postman to test the data responses on GET calls to each endpoint.
    Note: It is up to the end user to secure their Client IDs and Secret Keys, as well as setting up the connections/integrations to third party applications.