API Documentation

Steps of the Integration Process

1. The integrator creates a test account at http://testing.maventa.com

   • Notify about the established test account via email to integrations@maventa.com.
   • Maventa will create a Vendor API key for the test side and provide it to the integrator.

2. Once the integration is ready and the integrator wants to move to production:

   • Maventa performs a thorough integration validation.
   • Contracts are signed.

3. Integrator registers for production at secure.maventa.com

   • Maventa converts the account to a PARTNER account and delivers the Vendor API key for the production side.
   • Integrator implements the integration on the production side.

4. Maventa conducts production monitoring to ensure the integration works correctly in the production environment.

NOTE: Network or paper invoices sent via the test environment do not exit the test environment; invoices will not be delivered to the specified recipient even if the invoice status changes to "Sent." However, note that both the invoice and the invoice notification can still be sent to the email address provided in the invoice data. Therefore, it is recommended to use your own or the company's email for all test sends.

Authentication

Maventa's REST API, authentication is performed using an oauth2 standard token. All functionalities of the API require a valid oauth2 bearer token.

The POST /oauth2/token method is called using the company's credentials:

• client_id is the company_id
• client_secret is the user_api_key
• vendor_api_key

Here is an example of fetching a token from Maventa's API:

curl --location --request POST 'https://ax-stage.maventa.com/oauth2/token' \
--header 'Content-Type: multipart/form-data' \
--form 'grant_type="client_credentials"' \
--form 'client_id="xxxxxxxxxxxx"' \
--form 'client_secret="xxxxxxxxxxxx"' \
--form 'scope="eui"' \
--form 'vendor_api_key="xxxxxxxxxxxx"