Basware Data Extract APIs
Basware Data access APIs are based on REST API, they provide a mechanism to extract raw data from Basware AP Automation. The APIs are used to get a list of the extracts that are available for download. There can be one or multiple extracts available for download. Each extract is a collection of multiple data sets in ZIP files. This document describes data schemas and available methods. Basware APIs work using REST API calls initiated by customer. Please visit the Basware Data Access API pages on Basware API developer site for full API documentation. **Data formats** Basware APIs use JSON data format with UTF-8 character encoding. Descriptions of data fields are under the API methods, on tab 'Schema'. The API has a rich set of fields, many of which are optional. During the provisioning of the data extract service please make sure you ask for the correct format in which you would like to have the data extracts zip files. Supported formats are JSON or CSV. Note: - Formats need to be defined and agreed during the provisioning of the service and cannot be changed thereafter. Basware reserves the rights to introduce a new field in the data extracts zip file. Please make sure your integration is configured to read data from records returned in zip files using named JSON or CSV fields and does not assume the fields come in a predefined sequence of elements. **Authentication** API clients authenticate using OAUTH2 or Basic HTTP authentication. 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 are not accepted. API clients need to take into account that Basware domain certificates are renewed regularly. For details see, the authentication and access rights section on the Basware API developer site. **API Versioning** Every time there is a backwards-incompatible change to the API, a new major version will be released. This major version is part of the URL path. The current major version is v1. Unless informed by our technical support department that we are discontinuing support for a particular API version, you do not need to switch API versions. We will let you know at least 12 months in advance if an old API version is to be deprecated. Major change is a new version of the API that requires changes from the API consumer before the new version can be taken into use. This change would for example be a change to existing fields or adding new mandatory fields. Minor change is a new version of the API that is backward compatible and does not require changes from the API consumer. Minor change would consist of for example adding a new non-mandatory field. Please make sure your API client accepts new non-mandatory fields. **API Client requirements** API clients need to accept new JSON fields as well as absence of null fields from the response JSONs. Programs using Basware API need to handle redirects either at the application layer or the HTTP layer since certain APIs allow larger payloads by redirecting the response.