“Application Program Interface” - This is a software tool that connects two computer programs to each other. We have several APIs at Clarivoy that make it easy for our dashboard to get data from the database. We often use APIs from partners and vendors and clients to retrieve data.

Requesting Dealer Approval

CSL or CS Specialist

1. 🚀 If dealer selects a vendor that has an API method, Rocketlane sends out an email (the contents of the Task Notes) to the dealer, requesting their approval to integrate with the vendor via API.
2. Once the dealer responds APPROVED, set the task status to Data Pull Needed.
   1. 🚀 Rocketlane Automations will reassign the task to the Ops Team, who will take over from here.

Requesting API Keys

Ops Team

Once dealer approves, request API keys from vendors where needed.

1. From the Datateam email box, email the vendor, requesting an API key.  
   1. The vendor's support email address should be in the Private Note in the Rocketlane task. If it is not, reference the Vendor Details board to find their support email address.  
   2. A template may be provided in the Private Note in the Rocketlane task. If a template is not provided, make sure the email includes the following information:
      1. Property Information - Name, Address, City, State, Zip
      2. Screenshot of the dealer's approval, including the message where we requested the approval (Screenshot the entire task including the task notes and the chat where the dealer approved).
2. Set the task status to Waiting on Vendor.

API Keys Received

Ops Team

1. The vendor's support team will reply via email with the API keys.
2. Once the API keys are received from the vendor:
   1. Paste the API keys into the task conversation
   2. Enter the API key into the DMUI property 3rd Party screen under the appropriate vendor and click Save. Make sure the status=active!
   3. Set the task status to Waiting on Data.
      1. 🚀 RL will set the "Verify Data Date" task field to 2 days later

Verify Data

The process for verifying data differs depending on the data type:  Leads or Sales

Verify Data for Leads

Ops Team

1. 🚀 On the “Verify Data Date” (2 days after the task was set to Waiting on Data), a Rocketlane automation will flip the task status to Verify Data and create a private message in the task chat with a link to a Looker board to verify the data.
2. Verify that data has been received using the Looker link in the chat. Highlight the link using your mouse, right click and chose "Go to https://......" to open the link.
3. If the data is okay, set the Task status to Completed.
   1. ✴️ PRO - Zapier Integration creates a new item in the SA+TVA Ops Monthly Tasks board.
      1. For details on this process, see: Data Tasks Setting to Completed in Rocketlane.
      2. If the Monthly Task board item cannot be created by Zapier, an error message should appear in the task Chat explaining why.  Typically this is because the required fields are not filled in on the task's Additional Info tab (Method, Task Vendor, Data Type).
4. If there are any issues with the data, investigate the issue by checking:
   1. Verify the API key was entered into the DMUI correctly by checking against the original email reply.
   2. Check the API DAG server logs on the Jobs server for any error messages related to that specific API key/property.
   3. If the log contains the message “no data is returned for the date range”, email the vendor support team to inquire why.
   4. If another error message appears, email the vendor support team to inquire why.

Verify Data for Sales

Ops Team

1. When the task status changes to Verify Data (2 days after it was set to “Waiting on Data”), Ops team needs to verify the sales data is flowing and looks good.
2. Use the Looker Sales Dashboard link in the update to confirm data is flowing and looks good. Highlight the link using your mouse, right click and chose "Go to https://......" to open the link.
   1. If it is prior to the Start Date, you will not see data in the Sales Standardized chart. Check the Sales Raw chart instead.
3. Take a screenshot of the Sales Type from Raw chart which shows all of the Sale Types the dealer is using.
   
4. Paste this screenshot in a private message in the task chat.
5. If the dealer is NOT using any B2B Sale Types (Wholesale, W, Fleet, F, Dealer Trade, DT, D, X), tag the CSL in the chat and ask if they are okay moving forward with the dealer not identifying B2B sales, or if they want to address this with the dealer before proceeding.  Wait on the CSL's response before proceeding.
   1. If the dealer approves moving forward without B2B Sale Types, set Task Status to Completed.
6. If the dealer IS using at least 1 of the B2B Sale Types to identify B2B sales, set Task Status to Completed.
   1. ✴️ Zapier Integration creates a new item in the SA+TVA Ops Monthly Tasks board.
      1. For details on this process, see: Data Tasks Setting to Completed in Rocketlane.
      2. If the Monthly Task board item cannot be created by Zapier, an error message should appear in the task Chat explaining why.  Typically this is because the required fields are not filled in on the task's Additional Info tab (Method, Task Vendor, Data Type).