1What is this page? #
- The desktop's Tools -> Settings -> API Providers tab, one provider at a time. Find (F2) loads one, Add (F3) creates, Modify (F4) edits, Save (F5) stores, Esc cancels an edit or closes the page.
- In View mode nothing can be changed; press Modify first. After a save the page stays on the saved provider.
2Step by step #
- Press Add (F3) , key a name, and pick the API type and provider .
- Paste the Url the provider gave you.
- Type the credentials the provider issued - API key, client id and secret, and the portal sign-in if the service asks for one.
- Add any other parameters (semicolon-separated) and the body text if the provider's instructions call for them.
- Switch Default on if this is the provider to use for its API type, tick branches if only some branches use it (ERP edition only), then Save (F5) .
- To change a key later: Modify (F4) , type the new key in its box, save. The other credentials stay as they were.
3Credentials #
- The API key, client id, client secret and end-user password are stored encrypted, the same way the desktop stores them, and are never shown again - not even to an administrator.
- Each box shows whether a value is Saved or Not set . Typing replaces it on save; Clear removes it on save; an empty box keeps what is saved.
- Lost a key? Get it again from the provider and type it in.
4Fields #
- Name - required, up to 125 characters, unique.
- API type - required: IRN Request, IRN Cancel, E-Invoice By IRN, Eway-Bill By IRN, DocToVoucher, Transport or Others.
- Provider name - Webtel, IRIS Zircon API, Others, or your own.
- Url - required, a full http:// or https:// address.
- Default and Applicable branches - see the rules below; no branch ticked means all. Applicable branches is ERP edition only.
- End-user name - plain text, up to 255 characters.
- Other parameters - semicolon-separated; Body text - the request body template.
5Integrity rules #
- The name is unique .
- Only one default provider per API type may cover a branch; the save names the provider that already is.
- A provider an API profile or transporter setting uses cannot be deleted - point them at another provider first.
- Opening this page needs Execute on 'Settings' in User Manager (Tools tab) - the right that opens Settings on the desktop. Without it nothing is shown or saved.
- Every problem is listed at once, numbered.
6If something does not work #
"Requested action denied due to security restrictions. API Providers needs Execute on 'Settings' (User Manager > Tools)."
- Why
- Providers hold credentials for outside services, so the screen is gated on a tools permission.
- What to do
- An administrator grants Execute on Settings.
"Another provider is already named '...'." / "Name can't exceed ... characters."
- Why
- Providers are picked by name.
- What to do
- Choose a free, short name.
"Url must be a full web address starting with http:// or https://."
- Why
- A provider is reached at an absolute address.
- What to do
- Paste the full address from the provider's documentation.
"This provider no longer exists - someone deleted it."
- Why
- It was removed while you had it open.
- What to do
- Press F2 and pick again.
A credential cannot be read back
- Why
- Credentials are stored write-only: they can be replaced but never shown.
- What to do
- Type the new value; leaving it blank keeps the stored one.
This is the help InvoiceNET® ERP shows beside the API Providers screen. Whether you have the screen depends on the modules of your licence and the rights your administrator has given you.
See this screen for yourself
The demo is the real product, with a company of your own.