Providers
Providers are the data sources where we get the data. They support a list of data types.
To list and configure your providers refer to these endpoints.
You have to enable a provider before you can use it. Only providers marked as available can be enabled.
If you need a provider that is not available please contact the support at support-api@qardfinance.com .
Some providers require credentials to be enabled (credentials_config). You must set those credentials before enabling the provider.
Credentials required for a provider are described in each provider page (see Supported Providers).
In some cases Qard can set up the provider for you. Please contact the support if you need so.
Some providers are unique which means you can only have one data connection per user for this provider.
Some providers require an authorization (auth_required) from the user before you can access the data.
Configure provider's credentials
Use PUT /api/v6/providers/:providerName/credentials to update a provider's credentials
For security reasons you can only update credentials but not get them.
Enable/Disable a provider
Use PUT /api/v6/providers/:providerName to enable a provider. If the provider requires credentials you need to set them before.
Provider object
| Field | Type | Description |
|---|---|---|
| name | string | Technical name of the provider. To be used in other endpoints |
| logo_url | string | Url of the provider's logo in PNG format |
| enabled | bool | Whether or not the provider is enabled |
| available | bool | Whether or not the provider is available to your account |
| unique | bool | Unique providers may only be connected once per user |
| auth_required | bool | Wether or not the provider require an Authorization from the user before you can access the data |
| auto_connect | bool | Whether or not the provider is auto connected |
| settings | array of strings | List of settings configuration |
| credentials_config | array of strings | List of credentials you have to set before you can enable the provider |
| data_types | array of strings | List of supported data types |