OAuth Client
Your app's entry for Sign in with iVendNext: its address and what it may ask for. The retailer's administrator makes it.
Area: The retailer's setup · Why it is here: recipe portal; recipe sign_in · Fields: 11
Read and write it
Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.
Read a list (only name unless you ask for fields):
curl -s "https://⟨site⟩/api/resource/OAuth%20Client?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one, with its tables:
curl -s "https://⟨site⟩/api/resource/OAuth%20Client/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Create one (the required fields first), if your app's role may:
curl -s -X POST "https://⟨site⟩/api/resource/OAuth%20Client" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"app_name": …, "scopes": …, "default_redirect_uri": …}'
Change one with PUT /api/resource/OAuth%20Client/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.
Samples that use it
Fields
Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| App Client ID | client_id |
Data | yes | |||
| App Name | app_name |
Data | yes | |||
| User | user |
Link | yes | User | ||
| Allowed Roles | allowed_roles |
Table MultiSelect | OAuth Client Role | |||
| App Client Secret | client_secret |
Data | yes | |||
| Skip Authorization | skip_authorization |
Check | ||||
| Scopes | scopes |
Text | yes | |||
| Redirect URIs | redirect_uris |
Text | ||||
| Default Redirect URI | default_redirect_uri |
Data | yes | |||
| Grant Type | grant_type |
Select | one of: Authorization Code, Implicit | |||
| Response Type | response_type |
Select | one of: Code, Token |
Table: OAuth Client Role
The rows of allowed_roles. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Role | role |
Link | Role |