Generic API (HTTP)

Both products

What you will achieve

Sync a module with the client's own API.

Before you start

• The API's Base URL (for example https://api.example.com).
• API Key / Token.
• Auth Header Name: the header that carries the token (by default Authorization).

Step by step

1. In Settings → Credentials → Add credential, choose Generic API (HTTP).
2. Fill in Base URL, API Key / Token and, if needed, Auth Header Name.
3. Click Test and Save.
4. In Settings → Sync, enable the module and choose the credential.
5. In Resource, type the name of the remote resource.
6. Choose the Direction, adjust the Field mapping, click Save and Sync now.

How to verify

Test runs a request with the configured header; the run ends up as Synced.