Fields
The distributor's slug in the address, from GET /distributors, and your own credentials with it in the body. Needs Distributors: Read and write, a permission of Data Feed stores.
| Field | Type | Rule |
|---|---|---|
| credentialsrequired | object | One string for each entry of the distributor's credential_fields, under that entry's key, such as {"email": "…", "password": "…"}. Every one filled in, each up to 1,000 characters. Keys that are not in credential_fields are ignored. |
- Checked with the distributor before anything is saved. FFL Monkey signs in at the distributor with them, which can take up to 15 seconds. Only if it accepts them are they saved and the distributor switched on (
enabledtrue). - A refused or unreachable check saves nothing. Nor does a field that is missing or blank, which is refused before the distributor is asked anything. Credentials saved before are kept when a new set is refused.
- Never returned. No answer, change or webhook carries a credential, nor any part of one: the answer says only that they are
verified, and when. - Connected already? Sending it again checks the new credentials and replaces the old ones.
- What follows: exactly what follows a connect on your distributors screen. Saving the credentials is announced as
distributor_account.connected; switching the distributor on, aslicense.distributor_selection.changed, and your products and prices are worked out again.
5 a minute and 20 an hour per store
Each PUT signs in at the distributor, and a distributor may lock an account after repeated failed sign-ins. So your store may send 5 a minute and 20 an hour, whichever key sends them, refused ones counted, on top of the key's own limit. Fix the credentials rather than retrying the same ones. Disconnecting is not limited.
Returns
- 200Connected: the distributor as GET /distributors now shows it, in
data, withcredentialsverified. - 404distributor_not_found: no distributor FFL Monkey offers has that slug.
- 422validation_failed: a credential is missing or blank, named as
credentials.<key>; orcredentialsitself when the body has none at all, or when the distributor'scredential_fieldsis empty, as it cannot be connected through the API yet. The distributor was not asked. - 422credentials_rejected: the distributor did not accept them. Nothing was saved.
- 429rate_limited: more than 5 in a minute, or 20 in an hour, for this store. Wait for
Retry-Afterseconds. - 502distributor_unreachable: the distributor did not answer the check. Nothing was saved. The credentials may be right: try again in a few minutes.
This endpoint can also answer 401 invalid_api_key, 403 license_not_active, 403 product_not_included, 403 insufficient_scope and 429 rate_limited.