Get started with Basware API
Get Started
Basware API is a REST API based integration method to multiple Basware solutions. Data is transferred as JSON payloads through a Basware published REST API, which is accessible over public Internet. The data is distributed to multiple Basware solutions, such as P2P, Supplier Management and Basware Network, to reduce the need for multiple per solution integrations.
Prerequisites:
To access Basware API you need API credentials as well as access to a Basware solution (such as P2P or Supplier management). These will be provided by your Basware delivery project consultant or your technical partner manager.
Try it out
This example posts a GL account into Basware P2P. To interact with the API you can use any tool capable of posting HTTP messages, such as Postman or curl. This example uses Postman.
[
{
"accountCode"
:
"18620"
,
"accountNames"
: [
{
"translation"
:
"Machinery purchases"
,
"language"
:
"en-US"
},
{
"translation"
:
"Koneiden hankinnat"
,
"language"
:
"fi-FI"
}
],
"companies"
: [
{
"companyCode"
:
"01"
,
"inherit"
:
false
,
"active"
:
true
}
],
"externalCode"
:
"18620-01"
}
]
Send the above payload to Basware API:
- URL: https://test-api.basware.com/v1/accounts
- Enter your API authentication credentials
- Send the above payload in message body.
The above settings use Basware API test environment in European region. End part of the URL 'v1/accounts' determines the API being executed. Use Content-type: application/json. Make sure you have a company '01' in your target system. You can also change the value of 'companyCode' in message payload to match your target system.
In response you should get a '200 OK'. The posted GL account should now be available in Basware P2P.
Download preconfigured API call examples
Basware provides preconfigured API call examples with parameters already in place. This collection of API call examples is intended for integrating with Basware P2P. We recommend starting your development from the examples and adding the additional fields needed in your project.
Read more and download the preconfigured API call examples here.
Which APIs will I need?
Check out our API selection guide for a list of APIs required in the most common business scenarios.
Where to next?
If you are considering using Basware API in your projects, you might want to find out how well you can program the web service calls required for using API from your ERP system or integration platform. If you want to dive deeper into the API functionality itself, please check out the Purchase-to-Pay API reference for supported methods or the Purchase-to-Pay API manual for most common usage scenarios, common considerations and fair use practices.
When you have an integration project ongoing, the message payloads and call logic will be fine tuned and tested to match your business needs and ERP system. Usually this is done in dialogue with Basware consultants.