Roles

Within the CPL API interface, a system of user roles and permissions has been implemented to ensure secure and controlled access to individual API functionalities.

Roles allow precise definition of which operations a specific user or integration account is permitted to perform. This makes it possible to separate administrative activities (e.g., access management) from standard operational API usage (e.g., calling selected endpoints).

Role Overview

Role	Description
apiAccessManager	This role allows the user to create access credentials for the CPL API. It is intended exclusively for PPL integrators.
client	The client role is assigned by default when creating access to the CPL API. It allows access to all CPL API requests except those related to creating new access credentials.
pickupPoints	Users with this role can only download pickup point data. They have access exclusively to the GET /AccessPoint method and reference lists.
sandboxAccessManager	Allows creating access credentials for the Sandbox environment. This role is intended exclusively for PPL integrators.
supervisor	The supervisor role provides access to all CPL API methods. It is intended exclusively for integrators.
tracking	Users with this role can only track shipments. They have access exclusively to the GET /shipment method.

Role Overview#

Role Overview