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.
What are the possible statuses of your API client connection request?
- Approved - your program has been successfully connected to your API client
- Pending - The developer has not yet approved or denied the new connection to your API client
- Denied - The developer of this client has rejected this connection and your client does not have API access
How to add a new API client connection to a program
- Navigate to the Lyft Business Portal -> Concierge -> Programs
- Select the program you would like to give API access to
- Select ‘Edit’ in the top right corner
- Scroll down to ‘Optional settings’ until you see ‘API client connection’ and select drop-down
- Select ‘Add client’
- Input the Client ID and select ‘Save’
- Your will then see a ‘Pending’ status and your request will be sent over to your developer in the Lyft Developer Portal for approval
How to delete an API client connection
- Navigate to the Lyft Business Portal -> Concierge -> Programs
- Select the program you would like to give API access to
- Select ‘Edit’ in the top right corner
- Scroll down to ‘Optional settings’ until you see ‘API client connection’ and select drop-down
- Find the client you wish to delete and select the trash can icon
- You will see the below pop-up and then select the red ‘Delete’ button
- You will then be automatically redirected back to your program edit page and will see a ‘API client deleted’ notification
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.