Comment on page

Configuration

API endpoints
Authentication: endpoints listed in this page require header authentication with a config token.
The config token is only available in the Settings section of the console.
Configuration management
get
https://{domain}.biapi.pro/2.0
/config
Get the domain configuration
post
https://{domain}.biapi.pro/2.0
/config
Update the domain configuration
Configuration logs
get
https://{domain}.biapi.pro/2.0
/config/logs
Get the logs of configuration updates
Certificates management
get
https://{domain}.biapi/pro.2.0
/certificate/{type}
Get a certificate
Configuration keys
Configuration key
Type
Default
Description
autosync.retry_wrongpass
Boolean
1
Allows to retry automatic synchronizations for connections in "wrongpass" error state. Second attempt occurs 12 hours later. Next attempts will then occur every 7 days.
biapi.allowed_origins
String
Empty string
Specifies authorized website domains when cross-origin is needed (when using iframe on webpages for instance). Multiple origins can be defined, comma separated.
biapi.manager.email
String
Empty string
Sets the recipient email address of the webhook error emails.
connectors.default_auth_mechanism
String
Empty string
Defines the auth_mechanism to be used if not already defined for the source or its related connector. Accepted values are webauth and credentials.
connectors.enable_new
Boolean
0
Enables new connectors by default as soon as they are deployed.
connectors.sources.enable_new
Boolean
1
Enables new sources on connectors. If not, new sources are disabled by default.
oauth2.enabled
Boolean
1
Enables OAuth2 protocol.
webhooks.alerts_frequency
Decimal
1
Defines the frequency of webhooks alerts, in days.
webhooks.compressions.enabled
Boolean
0
Enables the compression of the HTTP body of your webhook into gzip format.
payment.max_amount
Decimal
0
Defines a maximum authorized amount for pay transactions. 0 is considered as if the value was not set. There is no maximum.
Data model
Certificate object
Property
Type
Description
id
Integer
ID of the certificate.
type
String
The type of certificate.
id_public_key_file
Integer
​
id_private_key_file
Integer
​
created
DateTime
​

Configuration key	Type	Default	Description
`autosync.retry_wrongpass`	Boolean	1	Allows to retry automatic synchronizations for connections in "wrongpass" error state. Second attempt occurs 12 hours later. Next attempts will then occur every 7 days.
`biapi.allowed_origins`	String	Empty string	Specifies authorized website domains when cross-origin is needed (when using iframe on webpages for instance). Multiple origins can be defined, comma separated.
`biapi.manager.email`	String	Empty string	Sets the recipient email address of the webhook error emails.
`connectors.default_auth_mechanism`	String	Empty string	Defines the auth_mechanism to be used if not already defined for the source or its related connector. Accepted values are `webauth` and `credentials`.
`connectors.enable_new`	Boolean	0	Enables new connectors by default as soon as they are deployed.
`connectors.sources.enable_new`	Boolean	1	Enables new sources on connectors. If not, new sources are disabled by default.
`oauth2.enabled`	Boolean	1	Enables OAuth2 protocol.
`webhooks.alerts_frequency`	Decimal	1	Defines the frequency of webhooks alerts, in days.
`webhooks.compressions.enabled`	Boolean	0	Enables the compression of the HTTP body of your webhook into gzip format.
`payment.max_amount`	Decimal	0	Defines a maximum authorized amount for pay transactions. 0 is considered as if the value was not set. There is no maximum.

Property	Type	Description
`id`	Integer	ID of the certificate.
`type`	String	The type of certificate.
`id_public_key_file`	Integer
`id_private_key_file`	Integer
`created`	DateTime

Transfers (obsolete)

Next - API SETUP

Client applications

Last modified 7mo ago