Set up the API channel

• Admin

Set up the API channel when a webshop, an ordering portal or another system should send orders to Hyperfox as data instead of e-mail: the system posts each order to a web address, and the order appears in To validate with its fields filled in. The AI does not read these orders, because the system sends every field by name. The integrator who builds the connection follows Send orders through the API channel. If you are new to channels, read Channels, routes and mappings first.

Create the API channel

1. Go to Admin settings > Channels.
2. Under Add a channel, click Api.
3. In Label, enter the name of the system that sends the orders, for example "Webshop".
4. Under Request handling, choose how Hyperfox handles a request:
   • Validate request
     • ON: Hyperfox checks each order against the rules of your order model before it accepts the request. A request with an order that fails a check is refused, and the sending system receives the errors. Nothing appears in Hyperfox.
     • OFF Hyperfox accepts every request, and an operator corrects the order while validating it.
   • Auto approve When turned on every order of a request passes the checks, Hyperfox validates the orders at once and sends them to your ERP, without an operator. When one order of the request fails a check, every order of the request waits in To validate.
5. Click Create channel and the Endpoint card appears with the Webhook URL of the channel.
6. Switch Paused to Active and click Save.

Protect the Webhook URL with a signature

Without a token, the Webhook URL accepts every request that reaches it. With a token, the sending system must sign every request with that token, and Hyperfox refuses a request without a valid signature.

1. Under Signature, click Generate next to Token, or enter a token of your own.
2. In Signature header, enter the name of the header in which the system sends the signature. Leave it empty to use X-HF-Signature.
3. Click Save.
4. Copy the token and give it to the integrator through a secure route, such as a password manager. Treat it as a password.

You can also fill in Signature while you create the channel. A new token replaces the old one as soon as you save, so give the integrator the new token at the same time. To accept requests without a signature again, empty Token and click Save.

Stop receiving orders

Switch the channel to Paused and click Save: Hyperfox refuses every request to its Webhook URL and creates no order, until you switch the channel back to Active. The sending system receives an error, so it can send the order again later. To stop for good, click Delete channel. This cannot be undone. A new API channel gets a new Webhook URL.

See also

• Send orders through the API channel
• Channels, routes and mappings
• Validate an order: check it and send it to your ERP