Hello Michelin
Explore the Hello Michelin API: Your Easy Onboarding Gateway to API Integration !
Authentication details
To access the Hello Michelin API, users have three authentication options: Keyless access, API Key, and OAuth authentication.
- Keyless Access: This method allows users to make API calls without any authentication requirements, providing a straightforward entry point for testing or non-sensitive use cases.
- API Key Access: Users can register for an API Key through a specific registration plan available on our Developer Portal. Upon successful registration, you will receive your API Key, which you must include in the header of your API requests to gain access.
OAuth Authentication: For more secure interactions, users can complete a simple OAuth authentication process. First, register for a free and auto-approved subscription via our Developer Portal. Upon registration, you will receive your OAuth credentials, including a client ID and client secret.
Using these credentials, you can request an access token from our authentication endpoint. Follow the detailed steps outlined in our Knowledge Base articles to effectively retrieve your OAuth token. Once you have the token, simply include it in the Authorization header of your API requests to make authorized calls to the Hello Michelin API.
This multi-faceted approach ensures flexible access to the API, catering to various user needs while maintaining secure interactions.
Guidelines on how to use this API
To ensure a smooth and effective experience while using the Hello Michelin API, please adhere to the following guidelines: First, familiarize yourself with the available endpoints and their respective functionalities, which are outlined in the API documentation.
Always authenticate your requests using the OAuth token obtained during the authentication process to ensure secure access. When making API calls, respect the defined rate limits for your subscription plan to avoid interruptions.
Utilize the provided Knowledge Base articles for assistance with common tasks, such as retrieving your OAuth token and making your first GET request.
Additionally, ensure that your requests are formatted correctly according to the specifications provided, including the necessary headers and parameters.
If you encounter any issues, refer to the documentation or reach out to the support team for further assistance. By following these guidelines, you'll maximize the potential of the Hello Michelin API and streamline your development process.
To ensure a smooth and effective experience while using the Hello Michelin API, please adhere to the following guidelines:
- Familiarize Yourself: Understand the available endpoints and their functionalities, as outlined in the API documentation. Pay particular attention to the differences between the Keyless access, API Key, and OAuth authentication methods.
- Authenticate Requests:
- For API Key access, ensure you include your API Key in the header of your requests to authenticate successfully.
- For OAuth authentication, always use the OAuth token obtained during the authentication process to ensure secure access.
- Keyless Access: If you are using the Keyless access method, remember that no authentication is required, making it ideal for testing or simple interactions.
- Respect Rate Limits: When making API calls, adhere to the defined rate limits for your subscription plan to avoid interruptions in service.
- Utilize Knowledge Base: Use the provided Knowledge Base articles for assistance with common tasks, such as retrieving your API Key, OAuth token, or making your first GET request.
- Correct Formatting: Ensure that your requests are formatted according to the specifications provided, including the necessary headers and parameters.
- Seek Assistance: If you encounter any issues, refer to the documentation or reach out to the support team for further assistance.
By following these guidelines, you'll maximize the potential of the Hello Michelin API and streamline your development process.
Release notes
Initial release
We are initiating the release of the Hello Michelin API, designed to empower developers with a seamless introduction to API integration. This user-friendly API allows both Michelin and public users to make their first authorized GET request effortlessly through three access methods: Keyless access, API Key, and OAuth.
- Keyless Access: Users can easily make API calls without any authentication requirements, providing a straightforward entry point for testing and simple interactions.
- API Key Access: For those who prefer a more controlled approach, users can register for an API Key through a dedicated subscription plan. This allows for authenticated requests, ensuring secure access to the API's features.
With a straightforward authentication process utilizing OAuth, users can also obtain an access token to interact with the API. Upon successful calls, the API returns a friendly "Hello Michelin" message, providing instant feedback and validating the setup.
Accompanying this release are comprehensive Knowledge Base articles that guide users through the authentication process, covering all three access methods to ensure a smooth and supportive onboarding experience. With dedicated assistance available via our contact form, we are committed to helping developers confidently navigate API usage and unlock its full potential.