Concepts

The words used in these docs.

Account

An account is a customer. An account holds:

People
Sites
Articles
Sources
Delivery keys

Nothing crosses between accounts.

Access is account wide. Everyone on an account works on every site in it.

Site

A site is a website that shows articles. A site is a name. It holds no url. The host that serves an article owns the address.

An article can appear on many sites. Each site holds a separate slug for it. The same article can be lisbon-office on a site and lisbon-office-2 elsewhere.

So every article carries the slug on this site.

Field	What it is
slug	The slug on the site the key reads.

Article

An article has a title. It can also have a body and an excerpt and tags and an author name and a cover image.

An article moves through these states:

State	Meaning
draft	Being written.
in_review	Waiting for an editor.
changes_requested	Sent back by an editor.
approved	Cleared. Not out yet.
published	Live. The only state the API returns.
archived	Taken down.

Deleting is separate from the states. A deleted article goes to the trash. It stops being served. Restoring puts it back as it was. It returns to the same sites at the same addresses.

Trash held for	30 days

Source

A source is a partner who sends articles in. Each source has a url to post to. Articles from a source land on the sites set on that source.

Delivery key

A delivery key reads the site it was issued for. It is displayed at issue and never again. Only a hash is stored. A lost key cannot be recovered. Issue another.