Create Consumer
A consumer represents an end-user or organization that will connect to third-party services (or connectors) through your Chift’s Unified APIs.
his guide explains how to create and manage consumers in your Chift account.
What is a Consumer?
A consumer is an entity (typically one of your customers) that will use the connectors you’ve activated to integrate with various services.
Each consumer can have multiple connections to different services (accounting, pos, ecommerce, invoicing, …).
Each consumer is represented by a GUID and by a name.
A internal reference can as well be added (Feature available upon request).
Creating a Consumer
- Navigate to the Consumers page
- Click the “Add consumer” button
- Fill in the required information:
- Name: An identifier for the consumer (free text, up to you to choose if you want to use a guid or something more readable)
- Redirection url (optional): The url to redirect the consumer after authentication
- Email (optional): Contact email for the consumer. If filled in, this email will be used to send reminders and notifications (if activated in the account settings: Email Reminders)
- Click “Save” to create
- Once created, you will be able to copy the connexion url or to navigate directly to the consumer’s connexion page
In production, you will typically create a consumer through the API.
Activation of a connexion
Connections make the link between consumers and software. Each consumer can have multiple connections. A connection is represented by a name, a link to a specific software and link to a specific Chift API. A connection will for example represent the credentials to connect to an Odoo instance for a specific consumer.
- Navigate to the Consumers page
- Click on the three dots on the right of the consumer you want to activate a connexion for and select “Get consumer link”
- Navigate to the connexion page, choose the connector you want to connect to and click on “Connect”
In production, you will typically skip this page and let your users navigate directly to the connexion page of connectors.
- You will have to fill in the required information and click on “Connect” to initiate the connexion
- If successful, you wil be redirected to the consumers’s redirection url or back to the marketplace
In production, you will typically activate a connexion through the API. You will be able to retrieve the connexion url for a consumer and share it with him.
Managing Consumers
Once created, you can:
- View all your consumers in the consumers list
- Search for specific consumers using the global search bar
- Export the list of consumers to a CSV file
- Filter consumers based on their status or connections
- Edit consumer details by clicking on a consumer in the list
Next Steps
After creating a consumer and activating a connexion, you can:
- Use the API Explorer to test the APIs
- Create API keys to access our APIs
- Use our API endpoints to manage consumer data
- Monitor consumer activities and connection status
Create Consumer
A consumer represents an end-user or organization that will connect to third-party services (or connectors) through your Chift’s Unified APIs.
his guide explains how to create and manage consumers in your Chift account.
What is a Consumer?
A consumer is an entity (typically one of your customers) that will use the connectors you’ve activated to integrate with various services.
Each consumer can have multiple connections to different services (accounting, pos, ecommerce, invoicing, …).
Each consumer is represented by a GUID and by a name.
A internal reference can as well be added (Feature available upon request).
Creating a Consumer
- Navigate to the Consumers page
- Click the “Add consumer” button
- Fill in the required information:
- Name: An identifier for the consumer (free text, up to you to choose if you want to use a guid or something more readable)
- Redirection url (optional): The url to redirect the consumer after authentication
- Email (optional): Contact email for the consumer. If filled in, this email will be used to send reminders and notifications (if activated in the account settings: Email Reminders)
- Click “Save” to create
- Once created, you will be able to copy the connexion url or to navigate directly to the consumer’s connexion page
In production, you will typically create a consumer through the API.
Activation of a connexion
Connections make the link between consumers and software. Each consumer can have multiple connections. A connection is represented by a name, a link to a specific software and link to a specific Chift API. A connection will for example represent the credentials to connect to an Odoo instance for a specific consumer.
- Navigate to the Consumers page
- Click on the three dots on the right of the consumer you want to activate a connexion for and select “Get consumer link”
- Navigate to the connexion page, choose the connector you want to connect to and click on “Connect”
In production, you will typically skip this page and let your users navigate directly to the connexion page of connectors.
- You will have to fill in the required information and click on “Connect” to initiate the connexion
- If successful, you wil be redirected to the consumers’s redirection url or back to the marketplace
In production, you will typically activate a connexion through the API. You will be able to retrieve the connexion url for a consumer and share it with him.
Managing Consumers
Once created, you can:
- View all your consumers in the consumers list
- Search for specific consumers using the global search bar
- Export the list of consumers to a CSV file
- Filter consumers based on their status or connections
- Edit consumer details by clicking on a consumer in the list
Next Steps
After creating a consumer and activating a connexion, you can:
- Use the API Explorer to test the APIs
- Create API keys to access our APIs
- Use our API endpoints to manage consumer data
- Monitor consumer activities and connection status