Managing your API client and program connections

Learn how to connect programs in the Lyft Business Portal to an API client without having to wait on Lyft! 

In this article, we'll cover:


What is an API (Application Programming Interface) client?

This is a client application with a unique identifier that allows developers to have API access. An API client requires a connection to a program in the Lyft Business Portal for your client to successfully have Lyft API access. 

What is the Lyft Developer Portal?

This is where your developers can create the API client with a unique identifier. Your developer must approve of the program connection within the Lyft Developer Portal in order for your client to have access to the Lyft API. 

What is a Client ID? 

Every client application has a unique identifier, called a Client ID, that is created in the Lyft Developer Portal and found on the app’s credentials page. You can think of API client credentials as similar to using a username and password when you log into any web application that requires authentication, such as your email.


What is a program? 

A “program” is how we refer to a subset of a parent organization in the Lyft Business Portal. For example, a car company could have many dealerships at various locations, and each one of them would be a “program.”

A program can be a subset of business profiles, Lyft Pass and Concierge. Companies set up programs when they want each part of the organization to have separate reporting, offerings and/or guidelines.

Screen_Shot_2022-08-24_at_5.42.03_PM.png


What are the possible statuses of your API client connection request? 

  • Approved - your program has been successfully connected to your API client 

Screen_Shot_2022-08-29_at_4.54.25_PM.png

  • Pending - The developer has not yet approved or denied the new connection to your API client

Screen_Shot_2022-08-29_at_5.01.51_PM.png

  • Denied - The developer of this client has rejected this connection and your client does not have API access

Screen_Shot_2022-08-29_at_5.00.30_PM.png


How to add a new API client connection to a program

  1. Navigate to the Lyft Business Portal -> Concierge -> Programs 
  2. Select the program you would like to give API access to
  3. Select ‘Edit’ in the top right corner 
  4. Scroll down to ‘Optional settings’ until you see ‘API client connection’ and select drop-down
    Screen_Shot_2022-08-17_at_4.25.13_PM.png
  5. Select ‘Add client’
  6. Input the Client ID and select ‘Save’
    Screen_Shot_2022-08-17_at_4.41.50_PM.png

  7. Your will then see a ‘Pending’ status and your request will be sent over to your developer in the Lyft Developer Portal for approval
    Screen_Shot_2022-08-29_at_5.01.51_PM.png

How to delete an API client connection 

  1. Navigate to the Lyft Business Portal -> Concierge -> Programs 
  2. Select the program you would like to give API access to
  3. Select ‘Edit’ in the top right corner 
  4. Scroll down to ‘Optional settings’ until you see ‘API client connection’ and select drop-down
    Screen_Shot_2022-08-17_at_4.25.13_PM.png

  5. Find the client you wish to delete and select the trash can icon
    Screen_Shot_2022-08-17_at_4.47.12_PM.png

  6. You will see the below pop-up and then select the red ‘Delete’ button
    Screen_Shot_2022-08-17_at_4.51.20_PM.png

  7. You will then be automatically redirected back to your program edit page and will see a ‘API client deleted’ notification
    Screen_Shot_2022-08-17_at_5.00.25_PM.png

How to approve the API client connection from the Lyft Developer Portal

  1. As a developer, log in to the Lyft Developer Portal
  2. Select the ‘Apps’ tab at the top of the page
  3. Select the API client (app) for which you’d like to approve the program connection to. You will need to have an ‘Admin’ role in the app to approve the connection
  4. Select the ‘Programs’ tab of your Client ID page
  5. In the table, find the row of the program and select the three vertical dots icon on the right, then click on 'Approve' (refer to 'What are the possible statuses of your API client connection request?' section to understand the statuses). The API client to program connection should now be approved and you can start managing the program through the API


How to get additional help

If you’re unable to successfully connect your API client, you can always contact Lyft Business via our contact form. Email requests submitted through our contact form related to API client connection issues should receive a response within 24 hours. 

Back to top