Workflow

Client Portal API profiles and one-time tokens

Create, secure, review and revoke one token per external portal with sections, domain, server IP and rate limits.

28 connected guidesLive filterPermission-aware instructions
28 guides
Category

Proplix Secure API Gateway

Open guide →
Guide

Open the Client Portal API profile form

Use the visible Main Flow card.

Open guide →
Guide

Complete API name

Required administrator label, for example an external client portal name.

Open guide →
Guide

Complete Profile key

Enter a short internal identifier such as abc_estate_portal.

Open guide →
Guide

Complete Allowed domain

Record the external portal domain for reference/audit.

Open guide →
Guide

Complete Allowed server IPs

Optionally restrict calls to backend server IP addresses.

Open guide →
Guide

Set Rate limit per minute

Choose 10–1000; the visible default is 120.

Open guide →
Guide

Select allowed portal sections

Only checked sections are encoded into the portal profile.

Open guide →
Guide

Create the Portal API

Submit the form after selecting security and data scope.

Open guide →
Guide

Copy the one-time token

The newly generated private token is shown once in flash data and cannot be displayed again.

Open guide →
Guide

Store the token server-side

Never expose the master token in browser JavaScript.

Open guide →
Guide

Review portal profiles

The page lists existing portal profiles and enabled modules.

Open guide →
Guide

Revoke a portal profile

Use Revoke; status becomes revoked and authentication stops.

Open guide →
Guide

Understand usage metadata

Profile records can retain last-used information when authenticated.

Open guide →
Guide

Understand one-way portal token storage

The token is stored as a SHA-256 hash rather than recoverable plaintext.

Open guide →
Guide

Review detected enabled modules

Use the enabled-module display to understand available automatic data adapters.

Open guide →
Guide

Allow portal section: Client profile

Core customer/account profile.

Open guide →
Guide

Allow portal section: Contacts

Active contacts related to the customer.

Open guide →
Guide

Allow portal section: Invoices

Customer invoices permitted by portal rules.

Open guide →
Guide

Allow portal section: Invoice payments

Payments related to the customer invoices.

Open guide →
Guide

Allow portal section: Estimates

Customer estimates.

Open guide →
Guide

Allow portal section: Proposals

Customer proposals.

Open guide →
Guide

Allow portal section: Projects

Customer projects.

Open guide →
Guide

Allow portal section: Tickets

Customer support tickets.

Open guide →
Guide

Allow portal section: Contracts

Customer contracts.

Open guide →
Guide

Allow portal section: Customer files

Authorised customer files.

Open guide →
Guide

Allow portal section: Subscriptions

Customer subscriptions.

Open guide →
Guide

Allow portal section: Automatic enabled module data

Data from detected supported modules.

Open guide →