Articles on: Customer Management
This article is also available in:

How to onboard a new customer on API

Onboarding new customers to your API product is a crucial process that sets the tone for their experience with your services. This guide will walk you through a step-by-step approach to effectively onboard new customers, from creating their account to providing access to your API documentation.


Step 1: Create the Customer Account


User access: All roles


  1. Access the Dashboard:
  • Log in to your admin dashboard or platform where you manage customer accounts and API access.


  1. Navigate to Customer Management:


  1. Add New Customer: Click on the option to add a new customer.


  1. Save and Generate Account:


Step 2: Activate the API Module


User access: FleetiSuperAdmin, FleetiAdmin, FleetiCustomerService, FleetiCustomerServiceAdmin, FleetiSales, FleetiOperator


  1. Go to the customer account view


  1. Select the "Account" tab


  1. Module Management Section
    In the "Module Management" section, activate the "API Access" module.



Step 3: Add a User to the Customer Account


User access: All roles


  1. Select Customer Account:
  • Go to the recently created customer's account in your dashboard.


  1. Navigate to User Management:
  • Go to the tab Fleeti One


  1. Add New User:
  • Click on the option to add a new user within the selected customer account.
  • Use the customer's email as the user's email for easy association.


  1. Save User Information:
  • Save the user's information, ensuring that they are linked to the relevant customer account.


Users created in the "Fleeti One" tab will have access to Fleeti One and the API with the same account.With the "API Access" module activated, user accounts created in the "Fleeti One" tab will no longer receive a welcome email for Fleeti One. Instead, they will receive a welcome email for Fleeti API. As mentioned earlier, the same login credentials can be used to log in to Fleeti One.


Step 4: Provide API Documentation URL


User access: All roles


  1. Access API Documentation:
  • Ensure that your API documentation is up-to-date and hosted at a stable URL: API Documentation


  1. Compose an Email:
  • Craft an email to welcome the customer and provide important information.
  • Include the API documentation URL and emphasize its importance for understanding your services.


Starting from October 23, 2023, the data model is changing. API clients are required to update their systems to comply with the planned migration. The migration API documentation is available here.


  1. Send the Email:
  • Send the email to the customer. Ensure that it is clear, concise, and includes all necessary information.


Onboarding new customers to your API product is a multi-step process that demands attention to detail. By following this step-by-step guide, you can ensure that your customers have a smooth experience from account creation to accessing essential API documentation. Effective onboarding establishes a strong foundation for a productive and collaborative partnership.


Updated on: 04/09/2024

Was this article helpful?

Share your feedback

Cancel

Thank you!