SunRegistry

SunRegistry is a shared catalog of tanning vendors, equipment models and retail products. Linking your records to it saves typing and gives you consistent names, descriptions, specifications and photos.

Linking your records

When you add a vendor, model or product under Settings, you can search SunRegistry and choose the matching entry, or you can create a custom record of your own.

• Vendors: Link a vendor first.
• Models and products: To link a model or product, its vendor must itself be linked to SunRegistry's matching vendor.
• Custom records: Anything you cannot find in SunRegistry can be created manually. Custom records have no catalog details.

SunMule fills in the name, image and status from SunRegistry when you link. You can open a linked record to see its details, such as the description, specifications, links and photo gallery. These details are read-only and are managed by SunRegistry.

A vendor's link cannot be changed or removed while models or products are linked through it.

Keeping in sync

SunMule refreshes linked records from SunRegistry every night. Each linked record has a status:

• Active: The entry is current.
• Inactive: The vendor is no longer active in SunRegistry.
• Missing: The entry has been removed from SunRegistry.

If SunRegistry is temporarily unavailable, your records are left as they are.

SunRegistry is its own site with its own sign-in, so you can also browse the full catalog there.

Tenant API

Companies on the Solar Flare plan can read their own SunMule data from their own systems through a read-only REST API under /v1.

Getting a key

Administrators open Settings > Company, find API Access and generate a key.

• The key is shown once, so copy it immediately.
• Each company has one active key. Regenerating a key stops the old one working at once.
• You can revoke the key at any time, which turns API access off until you create a new one.
• Keep the key secret. Anyone who has it can read your data.

Making requests

Send the key as a bearer token:

Authorization: Bearer <key>

The API returns your company's data only. SunMule support can give you the API address for your account.

Resources

Add an id to the path (for example /v1/salons/<id>) to get a single record.

Options

• Paging: Lists use limit and cursor.
• Enabled: Use enabled to filter by whether a record is turned on.
• Include: Use include to add related data. Plans accept models. Salons accept rooms and equipment, and you can combine them (include=rooms,equipment). Vendors, models and products accept sunregistry to add the linked SunRegistry details.
• Rate limit: Each key is limited to 100 requests per minute.

The API describes itself with an OpenAPI document at /v1/openapi.json, and an interactive reference is at /docs.