Your API

The assistant can look up orders, returns, or shipment status when the group has a REST API. You connect that API in the app, under the group's integrations. It is not a call in the web or Node SDK.

Add a schema

Add integration, then REST API. Give Cusu an OpenAPI schema in either of two ways:

  • a URL Cusu can download
  • YAML or JSON pasted into the form

Imported methods stay off until you enable them. Turn off paths the assistant should not call.

If you have no schema, add methods one by one: method, path, and a short summary such as "Order status".

Authentication

Each API can send headers on every call:

  • no authentication
  • a bearer token
  • one custom header, name and value

Use the credential your store already expects. It stays in the group settings. It is not the widget's public key, and it is not the identify secret.