Facteur for developers

Facteur receives the emails your application sends in a test, and keeps them in an inbox. Receiving text messages is not yet in service. The API lets a script or a test suite list those inboxes, read and search the messages in them, and download their attachments, with no browser open.

Get an API key

An API key belongs to your organization, not to a person, so it keeps working when whoever created it leaves. You have to be an owner or an administrator of the organization to create one.

1. Open Settings, then API keys, in the Facteur app, and choose Create a key.
2. Give it a name, pick what it can do and which workspaces it reaches, then pick a duration of 30, 90, 180 or 365 days.
3. Copy the key as soon as it appears. Facteur keeps only a hash of it, so the key is shown once and cannot be shown again.

A read-only key is enough for a test suite.

Call the API

Every request carries the key in the Authorization header:

curl -H "Authorization: Bearer fk_your_key" https://api.facteur.eu/inboxes

A key can make 600 requests per minute. Past that, the API answers 429 with a Retry-After header.

Guides

Read your first test emailCreate a key, find an inbox, send it a message and read the code it carries.

AuthenticationSend a key, choose what it may do, and read the refusals.

ErrorsThe shape of a refusal and what to do about each code.

LimitsWait for a message, the ceilings, paging and the status of a message.

Receive email in a Playwright testA helper that waits for the email and a test that reads its code.

Receive email in a Cypress testA Node task that keeps the key out of the browser.

Migrate from MailosaurThe Facteur call for each job your suite does today.

SDKNo client library is published yet: call the API over HTTP.

The reference is also available as a document, public.json, and as a Postman collection, public.postman.json.

What is not published yet

No SDK and no plugin for Playwright or Cypress is published yet. From a test suite, you call the API over HTTP.

Facteur does not promise yet that the API stays as it is. The reference below describes the API of the day, and the address of a route carries no version.

API referenceEvery operation, the permission it needs and the refusals it can answer.

Help centreCreate a key, rotate it, read a message: the guides for the people who use the app.

FacteurWhat Facteur is, its plans and where your data is kept.