The Client Console is used to manage vehicle routing resources with a user-friendly interface through a web browser. It can also be used to manage payments, and refunds, respond to disputes, monitor integration, and more.

PRODUCTION	DEVELOPMENT

Use for all things related to production, including API keys. The production server is intended for actual operation.	Use for all things related to development, including API keys. The development server should be used for testing and development.

➕ Sign-up

To begin, connect with our team to see how Interplai can best suit your needs. Then, have an administrator sign-up for an account in the Client Console. New users get a free 7-day trial period in the Client Console before payment information is required.

📈 Dashboard

The dashboard overview enables users to save and keep track of key metrics. It contains the total count of the Optimization solutions generated based on the trips, and event activity with statistics for the day. The following can be found on the dashboard:

API Count – Used to track page hits and specific events such as creating and updating the data.
Total Trips Created – The number of inquiries that are generated for a vehicle to travel within the zones.
Total Routes – The total number of routes that are generated by optimization solutions.
Total Optimization Solutions – The total number of optimization solutions that have been generated by the optimization search engine.

💳 Billing

The Client Console allows users to manage end-to-end billing workflows, from initial billing setup and account-level budget management to customer invoice reconciliation. The billing process can adopt various rate contracts and automatically update accordingly. This section also provides date comparisons and the status of the billing process.

Billing Reports

The reports page displays a chart that plots usage costs for all projects linked to the Interplai API billing account. Users have the ability to filter the chart by time period or groupings (such as by Account or API Key). All transactional data can be filtered and reports can be exported in CSV format.

Payment Settings

Interplai processes online payments through Stripe. Under Payment Settings, users can link their Stripe account and update billing addresses.

Invoice

The Invoice page displays summary information including the Issue Date, Due Date Status, Discounts, and Invoice Total.

📇 API Management

API Reports

Track calls sent to the Interplai server and generate reports based on accounts or API keys. The visualization tool displays a chart of these calls to allow users to analyze trends.

Credentials

Create credentials to access the Interplai API. Interplai supports API keys, which is a simple encrypted string that identifies an application without a principal. They are useful for accessing Interplai data and are used to associate API requests with your account for quota and billing. API keys can be created anytime on this page, along with the management of already existing API keys.

👤 Users

An owner or administrator can invite users to the client console. When creating the invitation, a role can be assigned to the user to restrict access to the relevant parts of the account. Roles include Owner, Admin, Developer, Finance, and Viewer.

Only one owner can be assigned to an account. An owner or administrator has access to the full list of users and can modify or delete user accounts. Upon inviting a user, the Firebase User Id is automatically created. There is no limit to the number of users per company account.

🌎 Visualization

The visualization tool allows users to see information in a zone displayed on a map. A user can choose the zone from a list, then choose to display certain optimization solutions associated with that zone. Additionally, vehicles can be plotted using color-coded markers to indicate the vehicle status (such as onDuty or offDuty). Pickup and drop-off points are also indicated by color-coded markers.

⬆️ Data Import

Using the Data Import tool, users can upload and integrate information into Interplai. This provides an alternative to generating optimization solutions based on API references.

More information on Data Import feature can be found here: Data Import.

🎫 Support

We provide support, including technical issues, billing, and key management concerns through our Service Tickets system. In the Client Console, under the Support section users can create service tickets and track the status of the ticket through FreshDesk. Users will need to set up a new FreshDesk account or link an existing account to create and manage tickets.