Supported methods for Basware APIs
API methods and fields
Detailed documentation for available methods and field sets for each API are described in the AP Automation API reference documentation.
Basware APIs support the following methods.
POST - Adds or updates records. Clears existing data from omitted fields
POST method updates the record based on externalCode field. If no record is found with given externalCode, a new record is created. All fields are updated within the record. Existing data in fields is cleared before the update.
PATCH - Updates records. Preserves existing data in omitted fields
PATCH method updates the record based on externalCode field. Difference to POST is that only fields included in the JSON in the request are updated. Data fields not explicitly included in the JSON request are left unchanged.
GET - Gets records from Basware API
GET method lists the records for a particular interface. Returned data contains all JSON fields and their values for the returned records. An externalCode can be specified as parameter to return data for only the specified record.
DELETE - Deletes records from Basware API
DELETE method deletes records from Basware API. The records are deleted from API only. To delete the records also from the data receiving Basware systems, use the data deletion mechanisms provided by each of the Basware receiving systems.
Data update scenarios
Below is an illustration of system behaviour in various data update scenarios.
Push notifications
To receive push notifications, customer needs to publish a webservice which receives notifications in a predefined format. These notifications trigger customer system to fetch documents from Basware API, which enables near real-time transfer of documents. Data export notifications are available for the following APIs. When notification is received, you can immediately retrieve data from the same API(s) as would be polled otherwise.
- AccountingDocuments
- ExportedPurchaseOrders
- ExportedPurchaseRequisitions
- ExportedContracts
- ExportedContractSpends
- RequestStatus
Subscribing to push notifications
Receiving the notifications requires customer to publish a webservice which receives task notifications in below JSON format. This webservice needs to be accessible from public Internet. Each nofitication is signed a using secret key which is self-service changeable by customer.
[
{
"taskId": "sajkhe1i87yhdgdi6sad7iyahljh1ut1",
"taskStatus": "New",
"taskType": "AccountingDocuments",
"taskSubtype": "WaitingForTransfer",
"documentId": "sajkhe1i87yhdgdi6sad7iyahljh1ut1",
}
]When the webservice to receive notifications is up and running, customer can subscribe to receive webhook notifications. This is done by specifying your webhook endpoint address as well as details on which notifications you want to receive through the 'subscriptions' API.
When subscribing, Basware API will verify the endpoint by posting a test notification with taskType 'ConnectionTest'. Customer system needs to return a 200 'OK' HTTP response to this request for the subscription endpoint to be validated. When subscribed, notifications for any new API tasks will be sent to your specified webservice address.
Recommended usage patterns
When you receive a notification, you should do a GET request to the interface specified by the notification's (field 'taskType'). Since one GET operation can return multiple documents and new notifications may arrive before the GET operation finishes, Basware recommends following usage patterns.
Usage pattern 1: GET multiple documents in a single thread (recommended)
- Start the thread for fetching documents when a webhook notification is received.
- If a thread is already running, do not start another one before the thread completes in order to to prevent receiving same documents twice. Instead, start the new thread after task has completed in order to fetch any remaining documents.
- Use acknowledge or lastUpdated to get the next round of documents.
- Have a (nightly) task which polls for new documents in order to prevent missing documents due to network or other issues.
Usage pattern 2: Get each document by documentId
- GET each invoice individually by invoiceId as soon as the notification arrives.
- Have a (nightly) task which polls for new documents in order to prevent missing documents due to network or other issues.
- Note: Sending webhook notifications is not retried, but you can use the 'tasks' API to check for any notifications whose delivery has failed.
Validating notification signature
In order to secure your webhook endpoints, which receive calls from Basware, Basware signs the webhook events it sends to your endpoints by including a signature in each request’s header. This allows you to verify that the event requests were sent by Basware and not by an unauthorized third party. Here is how to validate the signature with example payload contents.
Request header parameter 'x-bwapi-signature-256':
Name: x-bwapi-signature-256
Value: t=1629118316,v1=55258f455c0c0427527679626967148475a12d68b19248b69a903a9970b35a02
JSON payload:
[{"taskId": "1a2ee1c0-d0ab-486d-8da6-95a8d4ac37ce", "taskStatus": "New", "taskType": "AccountingDocuments", "taskSubType": "WaitingForTransfer", "documentId": "3661018bdfe24eeea2ec271a45eca5b4", "expirationTime": null}]
Validation instructions:
1. Read request header parameter 'x-bwapi-signature-256'
- 't=1629118316' indicates the timestamp (in epoch format). Timezone: UTC.
- 'v1=55258f455c0c0427527679626967148475a12d68b19248b69a903a9970b35a02' contains the signature.
2. Check notification timestamp
- Compare timestamp t=1629118316 to current datetime. Reject the notification if it is too old.
- Useful tool for converting the time: https://www.epochconverter.com/
3. Calculate signature from request payload
- Create a string in format TIMESTAMP.NOTIFICATION_PAYLOAD
- Example: 1629118316.[{"taskId": "1a2ee1c0-d0ab-486d-8da6-95a8d4ac37ce", "taskStatus": "New", "taskType": "AccountingDocuments", "taskSubType": "WaitingForTransfer", "documentId": "3661018bdfe24eeea2ec271a45eca5b4", "expirationTime": null}]
4. Calculate HMAC-SHA256 hash from the generated string using pre-specific secret key.
- The secret key has been specified by customer when subscribing to receive push notifications through /v1/subscriptions API. The key is specified in field 'webhookAuthenticationToken' in /v1/subscriptions API. It can be changed at any time by updating the subscription. Values used in this example below:
- Secret key: ad65rujltr9093ijhdkutiyua09döijhsa76d8799w8pqugdfafjdhfkjhadls
- Resulting hash using above example values: 55258f455c0c0427527679626967148475a12d68b19248b69a903a9970b35a02
- Note the resulting hash is the same as in 'v1' on the header parameter.
- Useful tool for calculating the signature: https://www.devglan.com/online-tools/hmac-sha256-online
5. Compare the calculated signature with value given in header parameter
- Get value from 'X-BWAPI-Signature-256' header parameter, field 'v1'.
- Reject the notification if the values are different.
- Else accept the notification.
Notes: Webhook payloads may contain unicode characters in the future. If your language and server implementation specifies a character encoding, ensure that you handle the payload as UTF-8.
Usage scenario 1: Import master data
Basware solutions require a set of master data that replicate the Customer’s business model in Basware. This data is required to enhance the processing of business documents and makes it possible to bring all, or suitable parts of the validation logic to Basware.
As best practice, master data should be maintained in one central place. This data nearly always sits in an organization’s main ERP system. Basware API is designed for importing master data to Basware services from your central master data store(s). Master data can be made available in all supported Basware services.
Posting and updating basic records
The following diagram illustrates data flow for posting master data, such as basic data records and user data, to Basware API.
This is applicable for the following entity types (APIs):
- Accounts
- AdvancedPermissions
- AdvancedValidations
- ApplicationGroups
- Contracts
- CostCenters
- ExchangeRates
- GenericLists
- PaymentTerms
- Projects
- TaxCodes
- Vendors
POST operation must be used when first sending the record to Basware API. Records can be updated using both POST and PATCH operations. Basware recommends using POST operation to also update the records for most cases. PATCH may be more suitable when, for example, the sending system provides only the changed fields within the modified record.
Note that GenericLists API can be used to populate several different lists. The list key needs to be specified as additional parameter for this API.
Usage scenario 2: Import external purchase orders for Order Matching
In order matching a purchase order, purchase order line, or a goods receipt is linked to an invoice or invoice line. Basware API supports importing external Purchase orders from customer systems to order matching. Purchase orders, purchase order lines and goods receipts can be imported and updated using Basware API.
These orders need to be fully processed, approved, and marked received in external systems. These orders are called matching orders and they are used only for automatic matching to received invoices. Creating, approving and sending orders can be also done in Basware Procurement system, which has another set of APIs to integrate the procurement process with external procurement systems (see section "Usage scenario 4: Import and export procurement data").
Posting and updating matching orders
The following diagram illustrates data flow for transferring and updating order data for use in invoice matching. Purchase orders from external systems are received through the MatchingOrders (order headers) and MatchingOrderLines (order lines and goods receipts) API entity types.
Order header needs to be received before the order lines are sent. Both order headers and order lines can be updated through API when they are changed, for example when changing requested delivery date or when items have been received.
Expand below sections for status diagrams of invoice transfer flow in accoutingDocuments API. These describe the available status transitions in 'processingStatus' field.
AccountingDocuments processingStatuses: Main flow
Below diagram describes the main flow in terms of invoice status transitions in AccountingDocuments API.
AcccountingDocuments processingStatuses: Exceptions
Below diagram describes the available statuses in exception situations. Some of the exception statuses are currently reserved for future use. These are in grey and there is no interaction path leading to those statuses at the moment. Retransferring an invoice from P2P will start the invoice process again as in the main flow above. Note: If a prebooked invoice is returned, prebook cancellation may need to be triggered in ERP system from 'WaitingToBeReturned' status. Most returned invoices are reprocessed and retransferred again to ERP.
The following diagram illustrates the data flow for retrieving prebooked or approved invoices (AccountingDocuments) from Basware AP Automation to accounting and handling related response messages.
.jpg?width=800&height=540&name=Usage-scenario-3-Prebook-and-transfer-invoices-to-Accounting-3%20(2).jpg)
Usage scenario 4: Import and export procurement data
The procurement subset of APIs is used to integrate Basware Procurement with external procurement systems. These APIs are not used to import orders for matching. For matching please see Usage scenario 2: Import external purchase orders for Matching. Basware Procurement handles the procurement process. It allows users to approve the purchase requisition, sends created order(s) out to supplier(s), handles any changes done in ordering phase and allows documenting that goods have been received. Orders created in Basware Procurement are also automatically available for invoice matching along with the documented goods receipts.
Procurement data integrations scenarios
- Basware API currently supports importing purchase requisition draft(s) to a specified owner on valid organization. The imported data is pre-validated by Basware Procurement making sure that document contains sufficient data required by purchase process setup. Purchase requisition can contain lines to many suppliers. Result of requisition approval process (requisition approved or cancelled) can be retrieved from Basware API as an exported purchase requisition.
- Basware API also supports importing purchase orders. Purchase orders (single supplier) are already approved before importing so they bypass approval process and are automatically sent to supplier.
- Basware Procurement supports contract based procurement. Contract metadata can be imported through Basware API contract import. Contracts link buyer and supplier in requisition.
- Contract metadata can be exported along with total contract spend through exported contracts API. Individual spend events linked to contracts are available through exported contract spends API. The API exports spends of invoices, spend plans and purchase orders against contracts. Spend events of matching orders are not collected separately but they are included in the invoice spends. These exports are currently available only for contracts created through contract import API.
- Orders sent to suppliers can be exported from exported purchase orders API. Whenever the order status changes, the data in API is also updated.
- Basware API exported purchase orders also include goods receipts registered in Basware Procurement. The goods receipts can originate from Basware API goods receipt import or Basware Procurement UI actions.
Below picture illustrates available order and requisition document flows. The operations between Basware Procurement (referred to as P2P in below picture) and external procurement system are performed using Basware API.
Purchase APIs - Orders and Requisitions
Below diagram illustrates document flows for contract documents. The operations between Basware Procurement and contracting system are performed using Basware API.
Purchase APIs - Contacts
APIs for importing procurement data:
Importing procurement data is done in similar manner as master data imports. See Usage scenario 1: Import Master data for more details.
APIs for exporting procurement data:
Exporting procurement data is done in a similar manner to invoice transfer (Usage Scenario 3: Prebook and transfer invoices to Accounting). Exported data is made available in the exportedPurchaseRequisitions/ exportedPurchaseOrders / exportedContracts / exportedContractSpends APIs. Export is confirmed by sending an acknowledgement response. Documents which have been acknowledged are marked as 'Exported' and can be filtered out from the next get request.
Usage scenario 5: Error handling and monitoring
You can check request status from end-systems (which receive data asynchronously) through ‘requestStatus’ API. When you POST records to Basware API, the posted data contents are schema validated on API layer and then distributed asynchronously to one or more target system(s).
In case an error occurs when target system(s) process the record, it will be returned through 'requestStatus' API. This API can be queried to check status of a request POSTed to Basware API. Errors returned by target systems are typically data validation errors that cannot be validated on the API layer. Examples of such errors would be "Company not found in target system" or "Cannot resolve username 'JOHNSMITH' to a valid purchase requisition owner". You can choose to query only errors or also success' responses. Retrieving only the errors should be enough for most use cases. Success responses indicate that the request has been succesfully processed in all of the target systems. If this does not occur within three hours, an error response is returned.
There is also an older 'errorFeedbacks' API, which returns only errors from Basware AP Automation ('success' responses are not available). The 'errorFeedbacks' API is likely to be deprecated at a later time. There will be a 12 months notice period before eventual deprecation. Currently both APIs are functioning side by side and are returning same errors.
Retrieving request status messages from requestStatus API
Do a GET to 'requestStatus' API in order to retrieve target system processing status(es) for a POSTed request. Most often the request status response will be available within less than one minute. There are some conditions, such as a heavy initial data loads, where this can take longer. If there is no response from a target system within two hours, the request is set to ’Error’ status automatically. Checking this is done hourly, so max time until timeout is just below three hours.>
Request status is shown as 'error' if one or more of the POSTed records could not be imported to one or more of the target systems. Note that you need to query the API separately for both 'success' and 'error' statuses. If parameter 'status' is not used in the GET requestStatus query, the API defaults to returning only messages which have received 'error' status. Basware recommends following ways to programmatically query the API.
Option 1: GET by status + acknowledge
- Get by statuses: 'error', 'success'.
- This needs to be done in two GET requests.
- POST acknowledge for all requestIds (to which status response is received)
- Acknowledged status responses are no longer offered on the next GET request.
- Acknowledging changes the status: 'Error' -> 'AcknowledgedError', 'Success' -> 'AcknowledgedSuccess'.
- Repeat from step 1.
Option 2: GET by lastUpdated timestamp.
- GET with 'lastUpdated' timestamp
- Include a stored 'lastUpdated' timestamp in GET request. Get by statuses: 'error', 'success'.
- This needs to be done in two GET requests.
- Store the 'lastUpdated' timestamp locally.
- Store the latest 'lastUpdated' timestamp separately for 'error' and 'success' statuses.
- Repeat from step 1.
Option 3: Get by requestId
- Save the returned requestId when doing a POST/PATCH request to Basware API
- RequestId is returned as a header parameter in response message.
- Query the API using the requestId until a response is received.
Basware recommends doing GET requestStatus 1 minute after sending a request. If several requests are sent over time, you can do GET requestStatus once a minute until the last request has been sent. It's also a good practice to additionally poll requestStatus API every 10..60 minutes to receive responses for potentially long-running requests. If status responses to all request have been received, this polling can be stopped until a new request is sent to Basware API.
Usage scenario 6: Import companies
Importing companies is a network-only usage scenario (this API does not import companies to Basware AP Automation system). Companies are imported through the 'companies' API. The sequence of API messages is same as when posting master data records.
The company identifier type (field identifiers.schemeId) needs to be specified from available values. Please expand the element under the flow diagram for a table of available values.
Usage Scenario 7: Import users
Users can be imported through the 'users' API. It is possible to import user(s) to any of the following Basware applications: AP Automation, Supplier portal (network), Supplier Management (network), CloudScan 3.0, SmartPDF. The log-in-to-application rights are managed through both 'users' and 'applicationGroups' APIs.
Before importing users, you need to have one or more application Group(s) set up for the users. Application groups provide log-in access to applications when applicationGroups are assigned to users. Each user contains a section specifying which applicationGroups the user has access to. After the application groups are set up, POST user(s) while specifying their assigned applicationGroups.
If some of your end users require access to more Basware systems than other users, you will need to define multiple applicationGroups. An example of this would be access to AP Automation and Vendor management for some users while most users access only AP Automation. If you need to define invoice approval rights for users on coding row level, you can also import these using 'advancedPermissions' API.
User management can be also done as self-service through the user management UI modules of individual applications. For SmartPDF, CloudScan 3.0 and Basware Reporting, UI based user management is handled centrally through Basware Admin web application.
Note: If you are not importing users from scratch but have an existing Basware AP Automation tenant where users have already been created, it is still possible to move user maintenance to Basware API. See FAQ article "Can I migrate user maintenance to users API on an existing Basware AP Automation tenant" for what needs to be taken into consideration.
Usage scenario 8: Retrieve invoice status
High-level invoice status can be queried through Basware API. The 'accountingDocuments/status' API receives search criteria (company code, invoice number, invoice date and optionally gross sum) and returns the status: ‘In Approval Process’, ‘Ready For Payment’, ‘Paid’ or ‘Rejected’. If further information is required from the invoice, the returned 'invoiceId' identifier(s) can be used to retrieve full invoice details through 'accountingDocuments' API.
A typical use case is providing self-service access through buyer supplier portal for suppliers to self-service query invoice statuses, by integrating the API to an existing buyer supplier portal. This will reduce queries that need to be handled manually by the AP team. This feature can be used for both API transferred invoices as well as invoices transferred outside of Basware API through a file-based integration. Following high-level statuses are returned:
- InApprovalProcess - Invoice has been received in Basware AP Automation and is being processed. This includes all invoice statuses before successful transfer to ERP.
- ReadyForPayment - Invoice is approved for payment and has been transferred to ERP system.
- Paid - Invoice has been paid.
- Rejected - Invoice has been rejected.
To enable this feature for your organization, please contact your Basware consultant or Basware Support. Invoice statuses are available for invoices that have had above status changes after the API has been enabled.
Usage scenario 9: Transfer enriched invoices for approval in external system
In addition to handling full invoice approval flow in Basware AP Automation, it is also possible to use AP Automation for invoice preprocessing without approval flow. Basware Invoice Enrichment offers business rules, duplicate checks, manual and automatic enrichment, search, invoice dispute, document removal capabilities on documents before they are transferred to an ERP or AP system for further processing and approval.
Transferring these enriched invoices is done through accountingDocuments API which is also used for transferring approved invoices to accounting. The 'p2pProcessingMode' parameter is used to distinguish between enriched invoices and those that are fully processed and approved for payment. Parameter value 'Standard' retrieves invoices processed using the standard AP Automation flow, which are already approved for payment. Value 'InvoiceEnrichment' retrieves enriched invoices, whose approval for payment is expected to be done in another system. Upgrading invoice transfer from invoice enrichment to full invoice processing in AP Automation requires removing p2pProcessingMode parameter and no longer sending the enrichmentResponse.
Transfer of enriched invoice transfer consists of the following steps
- [GET accountingDocuments]:
Get enriched invoices (Use parameters p2pProcessingMode: 'InvoiceEnrichment', processingStatus: 'WaitingForEnrichmentTransfer'). - [POST accountingDocuments/{invoiceId}/acknowledge]:
[Optional] Send technical acknowledgement (changes API processing status to 'EnrichmentTransferInProgress'). - [GET accountingDocuments/{invoiceId}/attachments/{attachmentId}]:
Retrieve invoice image file(s) - [POST accountingDocuments/{invoiceId}/enrichmentResponses]:
Indicate to Basware AP Automation did receiving system ingest the invoice succesfully (changes API processing status to 'EnrichmentTransferred' / 'EnrichmentTransferFailed'). - [POST accountingDocuments/{invoiceId}/transferResponses]:
[Optional] Indicate to Basware AP Automation when invoice has been transferred to accounting and approved for payment (changes API processing status to 'Transferred'). - [POST accountingDocuments/{invoiceId}/paymentResponses]:
[Optional] Indicate to Basware AP Automation when invoice has been paid (changes API processing status to 'Paid').
Below diagram illustrates the flow for transferring enriched invoices to invoice processing system and handling related response messages.
Authentication and access rights
Authentication
Basware AP Automation APIs support following authentication types to authenticate API clients. You can choose the authentication type when requesting Basware to create your API user.
- Basic HTTP authentication
- OAUTH2 (client credentials flow)
All communication is secured by using the HTTPS protocol (HTTP over TLS, TLS version 1.2 or later). You must make all API requests over HTTPS. API requests made without authentication will fail.
Using basic authentication
HTTP Basic authentication relies on passing a username and password along with each API request. The username and password are encoded into the HTTP Authorization request header.
Using OAUTH2 authentication
Basware AP Automation APIs support the OAUTH2 client credentials flow. The client credentials flow works by first requesting an access token from a dedicated API endpoint /v1/tokens using a client id and client secret (sent as Basic Auth header), then passing that token in subsequent API operations. This token is passed as a bearer token in the Authorization request header. You must specify the API operations permitted by the token when requesting the access token. Tokens have a limited validity time (default 1 hr), after which a new token needs to be requested. Token validity time can be specified while requesting the oAUTH2 credentials from Basware. Minimum allowed token validity time is 5 minutes and maximum is 24 hrs.
There is a separate swagger page for the APIs used to retrieve OAUTH2 tokens. Most integration tools have Oauth2 support built-in for both requesting an access token and using it in subsequent calls.
API operations permitted by an access token are called scopes. Available scopes are limited by access rights granted to API user. When returning requested scopes Basware API will ignore any missing or misspelled scopes. Scopes need to be always specified. For best security, recommended practice is to request only the scope(s) required for each API operation during production use. Multiple scopes can be specified by separating them with a blank space.
Each scope in Basware API consist of API name + allowed operation. Following operation are available:
- 'read' operation grants access to GET operations
- 'write' operation grants access to POST and PATCH operations
- 'delete' operation grants access to DELETE operations.
Available scopes used are listed below.
Scopes for Basware AP Automation APIs
accountingDocuments.read accountingDocuments.write accountingDocuments.delete
accounts.read accounts.write accounts.delete
advancedPermissions.read advancedPermissions.write advancedPermissions.delete
advancedValidations.read advancedValidations.write advancedValidations.delete
applicationGroups.read applicationGroups.write
companies.read companies.write
contracts.read contracts.write contracts.delete
costCenters.read costCenters.write costCenters.delete
errorFeedbacks.read errorFeedbacks.write errorFeedbacks.delete
exchangeRates.read exchangeRates.write exchangeRates.delete
exportedPurchaseOrders.read exportedPurchaseOrders.write exportedPurchaseOrders.delete
exportedPurchaseRequisitions.read exportedPurchaseRequisitions.write exportedPurchaseRequisitions.delete
lists.read lists.write lists.delete
matchingOrderLines.read matchingOrderLines.write matchingOrderLines.delete
matchingOrders.read matchingOrders.write matchingOrders.delete
paymentTerms.read paymentTerms.write paymentTerms.delete
projects.read projects.write projects.delete
purchaseGoodsReceipts.read purchaseGoodsReceipts.write purchaseGoodsReceipts.delete
purchaseOrders.read purchaseOrders.write purchaseOrders.delete
purchaseRequisitions.read purchaseRequisitions.write purchaseRequisitions.delete
requestStatus.read requestStatus.write
taxCodes.read taxCodes.write taxCodes.delete
taskStatus.read
users.read users.write users.delete
vendors.read vendors.write vendors.delete
Scopes for push notification APIs
subscriptions.read subscriptions.write subscriptions.delete
tasks.read
Note that scopes need to be separated by a blank space. If copy/pasting multiple lines from the list above, please remove the new line characters. Scope 'taskStatus.read' is required to query status of long-running DELETE operations.
Please make sure to have a mechanism implemented to automatically fetch a new token when your existing token expires. This is especially important for long-running tasks, such as a large initial load of matching orders which may take more time than the max validity time of one token (24hrs). Basware API does not support refresh tokens. You'll need to request a new token each time using the client id and client secret (same way as when getting the token for the first time).
API consumers can validate token signature using metadata from API endpoint /.well-known/jwks.json. Each token returned by Basware API is signed by by one of the public keys listed in the returned payload. The access tokens are returned as jwt tokens. Their contents can be viewed through jwt.io.
If you are currently using basic authentication and want to switch to using OAUTH2, you can request OAUTH2 authenticated API user credentials from Basware. You will receive a new set of credentials. Your existing basic authentication API credentials will continue to work alongside the new OAUTH2 ones. When you have fully made the switch, please request Basware to disable your previous API user credentials.
Access rights
API user access rights control what the user can do when interacting with Basware API. One user can be granted several kinds of access (read, write, delete) to several API endpoints. It is possible for example to have read access to AccountingDocuments and read+write access to Contracts on the same API user. You can request an API user having a combination of read/write/delete access to any of the APIs listed in this manual. If no restrictions are specified API users will have full access (read+write+delete) to all Basware AP Automation APIs. Changes to API access rights will take effect within 5 minutes from making the change.
Available access rights are:
- 'read' grants access to GET operations
- 'write' grants access to POST and PATCH operations
- 'delete' grants access to DELETE operations.
For full access, each of the above needs to be granted to user. Write alone does not grant access to GET operations and delete alone does not grant access to GET/POST/PATCH.
If the API user uses OAUTH2 for authentication, there are two levels of granting access. The first level is on the API user, specifying what access is granted overall for the user. The second level is controlled by the customer when requesting scopes on OAUTH2 access tokens. The scopes on the token determine which API operations are allowed when passing the token. If scopes are requested to API operations which is not granted to an API user, such scopes will not be granted through access tokens either.
Common scenarios where access restrictions are needed are:
- Restricting access for technical partners, who GET/POST data only to one API, such as Contracts.
- Restricting access for a reporting integration, which for example is only allowed to GET records