Public APIs

Public APIs / Messaging / The Mercure protocol

The Mercure protocol API

Mercure is a protocol allowing to push data updates to web browsers and other HTTP clients in a convenient, fast, reliable and battery-efficient way.

Open the The Mercure protocol documentation Build something with it

Key facts

Category
Messaging
Authentication
See docs
HTTPS
Yes
CORS
Unknown
Listed in
APIs.guru
Spec version
0.3.2

Authentication is described in the provider's OpenAPI spec and documentation. Most need a key or OAuth.

What you could build with The Mercure protocol

Messaging APIs send SMS, WhatsApp, chat and push messages, and receive the replies.

  • Booking reminders by SMS and WhatsApp
  • A shared inbox for customer messages
  • Two-factor codes on login

OpenAPI spec

The Mercure protocol has a machine-readable OpenAPI definition. Load it into Postman, Insomnia or a code generator to get every endpoint and a typed client in minutes.

Download the OpenAPI spec (JSON)

How we would integrate The Mercure protocol

  1. Generate a typed client from the OpenAPI spec, so every endpoint and field is checked at build time.
  2. Sign up with the provider, get a key and store it on the server in an env.php or secret store.
  3. Put a small backend in front of it, so the browser talks to your server and your server talks to the API.
  4. Cache results in your own database, so pages stay fast and you stay inside rate limits.
  5. Add monitoring: if the API goes down or changes, you get an alert before your customers notice.

Questions about The Mercure protocol

Does the The Mercure protocol API need an API key?

Authentication is described in the provider's OpenAPI spec and documentation. Most need a key or OAuth.

Is there an OpenAPI (Swagger) spec for The Mercure protocol?

Yes. The spec is linked on this page, so you can generate a client or import it into Postman.

Can I call The Mercure protocol from the browser?

It is not documented. Plan for a small server-side proxy to be safe.

Does The Mercure protocol support HTTPS?

Yes, it is served over HTTPS.

Can you build an app with The Mercure protocol for me?

Yes. FullStack Partner has developers who build and run products on APIs like this one. Send us a few lines and we reply with a plan and a fixed price.

Want a product built on The Mercure protocol?

We have the tech people: developers, designers and project managers who have shipped dozens of live products. Tell us what you want to build and we reply with a plan and a fixed price. Are you interested?

No sales spam. One reply from a real person, usually within a day.

More Messaging APIs

See all 12 Messaging APIs