Endpoint Composer

Available · 1.0

Make SAS data accessible to other systems with controlled access.

Endpoint Composer exposes SAS platform objects as secured API endpoints for external systems. Select the object to publish, define the allowed operations, assign a security profile, and use the generated runtime URL to make the endpoint available. External systems can then read or write records without requiring a SAS user account.

Endpoint Composer is built around three core concepts:

An endpoint publishes one object at one address, with a chosen set of methods.
A folder groups endpoints and can pass its security profile down to everything inside it.
A security profile decides who may call the endpoints that use it. API keys are created and managed on the profile.

Enabled endpoints are included in generated API documentation with runtime addresses, parameters, and example payloads. Use this documentation when configuring or handing over an integration to a consuming system.

Security design principle

Use separate security profiles for consumers that should not have identical access, and enable only the HTTP methods each consumer requires.

Use Endpoint Composer when

an external system must read platform data;
an external system must create or update records;
access must be controlled with API keys;
endpoint methods and key fields must be governed centrally.

Documentation map

Topic	What you will find
the restricted guide	Create a profile, key, and first endpoint.
the restricted guide	Folders, names, moves, enabling, and deletion.
the restricted guide	Object, methods, key fields, and inheritance.
the restricted guide	Create, distribute, and replace keys.
the restricted guide	Addresses, headers, reads, writes, and deletes.
the restricted guide	Publishing and access-management procedures.
the restricted guide	Resolve method, key, naming, and write errors.

Listeners

Listener functionality is part of Endpoint Composer and is available to customers. Use listeners for inbound signals such as webhooks and events. See Listeners — Endpoint Composer. Detailed field-by-field behavior will be expanded as the corresponding technical source is verified.

In this section

ListenersConfigure listeners in Endpoint Composer to receive inbound signals such as webhooks and events.

View the current version in the wiki