Skip to content

Customer Portal Logins ​

This configuration section allow administrator grant customer access to Customer Portal and Yeti Customer API

Id​
API Access's id.
Login​
Unique login of user that is used for authentication of access via API
Password​
Password of user that is used for authentication
Customer​
Customer that is associated with this API Access record.
Accounts​
Accounts that are associated with this API Access record. Empty value will grant access to all accounts related to customer.
Allowed IPs​
Array of IP addresses that is divided by comma. It is possible to use hosts or networks addresses here.
Customer Portal Access Profile​
Access Profile assigned to this login. Controls which sections and data are visible to the customer in the portal. Defaults to the built-in Default profile which has all permissions enabled.
Provision Gateway​
Optional Gateway used for provisioning purposes. When set, restricts provisioning operations to the specified gateway.
Allow Outgoing Numberlists​
Numberlists that this login is permitted to manage. Empty value grants access to all numberlists associated with the customer.

During authentication(see auth controller) Customer API will check Login, Password and Allowed IPs and generate JWT token that can be used to fetch information related to specified Contractor/Account.