Quick Start Guide For Developers

Michelin user

Use the MichelinID to connect to the API Portal.
Optional for publishers: If you plan to publish later, you can request the CREATOR role from your user profile.

External user

Select Sign up to create your account, then confirm the registration via the verification email.
After confirmation, sign in to the Portal.

Browse the catalog: Go to Products and use filters (type: REST or Async/Kafka), service and keyword search.
Open a product card: Each card links to a dedicated product page with Overview, Specification, Documentation, and Plan of Usage.

Review the product page:

• Overview: Business context, key features, and links.
• Specification: OpenAPI/AsyncAPI details, payload examples.
• Documentation: Authentication method (API key, Basic Auth, OAuth 2.0), reference endpoints, error codes, examples.

• Plan of Usage: Available plans (Trial, Limited Free, Unlimited Free, Paid, Request to Subscribe), approval type, environments, and quotas.

   

Select a plan that fits your use case:

• Trial: Time‑boxed evaluation (often mock or non‑prod data).
• Limited Free: Quota‑based free tier.
• Unlimited Free: Extensive access subject to fair‑use (typically internal).
• Paid: Premium access; invoicing handled outside the Portal.
• Request to Subscribe: Manual approval for specialized needs.

Click "Get Access"/"Request to subscribe" on the chosen plan.

Associate to an app:

• Use an existing app, or
• Create a new app (name, description, callback URL if needed, team/owner).

Approval workflow:

• Automated approval: Credentials are issued immediately.
• Approval required: You will be notified once approved.

You can track status (Pending/Approved) in My Account > My Apps.

Credentials depend on the product:

• API key
• Basic Auth (legacy/internal)
• OAuth 2.0 (recommended for partner/external use)

Environment access is defined by the plan:

• Mocked data (for safe testing)
• Non‑production (staging/sandbox, often anonymized)
• Production (live, strictly controlled)

Important: Portal‑issued credentials enable connectivity to the API gateway. Some products may require additional service‑level credentials provisioned by the API producer.