Skip to main content

Connection

Settings → Connection (Koppeling in Dutch) is where the shop is linked to your Typograph organisation, and where your website gets the key it uses to show the catalogue and take orders. Only an owner can open it: the key on this screen can read every design in the organisation.

The screen has four cards.

The app key​

The shop reads your designs with an app key, made in the Typograph portal.

  1. In the portal, go to Organisation → Apps and create an app for this shop. Give it three permissions: file:read, to read the designs, subscription:read, to check your plan, and publisher, to make the print files of orders. Use one app per shop: then you can revoke one without upsetting the others, and the portal's logs say which shop did what.
  2. Copy the app's Client ID and Client secret into the card on this screen.
  3. Press Connect and check. The shop tries the key straight away.

The badge at the top of the card says Connected since … when it worked, or Not connected yet with the reason beside it, such as a key that may not read designs.

The shop needs Typograph Pro or higher. A key from an organisation on a lower plan is refused. If the organisation later drops below Pro, the shop hears it from Typograph, switches the connection off and puts a Typograph plan below Pro notification at the top of Notifications; back on Pro, it switches on again by itself.

The secret is shown once. After saving, the card only says Set on …. To use a new secret, rotate it in the portal, press Replace, paste it and connect again. Closing the box without pasting anything keeps the current one.

Which projects this shop may see​

The key belongs to the organisation, so it never sees beyond it. These ticks make its reach smaller: a shop that only sells Christmas cards does not need to see the rest. Only designs in ticked projects can be added to the catalogue. Leaving every box empty is the same as ticking them all.

To narrow it further per colleague, see Projects per colleague.

Notifications​

When a design changes in Typograph, Typograph tells the shop, so it never sells an old version without you knowing. For that, Typograph needs to know where to send its messages.

  1. In the portal, create a webhook for the organisation, with the address shown under Receiving address: your shop's address followed by /webhooks/typograph, for the demo shop https://shop-api.typograph.nl/webhooks/typograph. Subscribe it to the design, form, project and plan events (template.*, form.*, project.deleted, subscription.*).
  2. Copy the webhook's signing secret into Signing secret, and press Save.

Without the signing secret the shop accepts no message at all: it would have no way to tell Typograph's messages from anyone else's. Developers find the details of the messages in Webhooks.

The tick boxes say which messages the shop acts on:

MessageWhat the shop does
A design has changedFor a product with its own copy, the new version waits under Notifications for someone to approve it
A form has changedThe same. A form that is no longer published, or now belongs to another design, becomes a notification
A design has been deletedA notification. A product with its own copy stays orderable until you decide
A form has been deletedA notification, the same way
A project has been deletedThe shop checks the whole catalogue against Typograph straight away
The Typograph plan has changedBelow Pro the connection goes off; back on Pro it comes on again

The first two can be switched off. The others are marked always on: they are how the shop learns that it can no longer make something it sells.

Messages can get lost, so the shop does not depend on them alone: every night it compares the whole catalogue with Typograph (see The nightly check).

Shop key​

Your website uses the shop key to fetch your catalogue and place orders. It belongs in the pages of your website and may be read by anyone: the list under it decides who may use it.

Allowed websites. Enter every address your storefront runs on, one per line, such as https://kaarten.nl. Only these websites can use the key. The list starts empty, which means no website can, so a new shop is not open to anybody until you fill it in. Give the addresses as your web developer gives them to you: the start of the address, without a path.

Create a new key if the key should stop working, for instance when you move to a new website. Every website that uses the current key stops working at once, until it has the new one, so agree on the moment with whoever builds your website.

For developers: the key and the list are explained in Webshop API → Authentication.

What is logged​

Every change on this screen is written in the Logbook: which part changed, by whom and when. The keys and secrets themselves are never written down.