Installation
Get started with the Oxygen Peppol API in minutes. This guide will walk you through setting up your account, getting API credentials, and making your first API call.
Prerequisites
Before you begin, ensure you have:
- A valid Oxygen Peppol account
- A development environment with HTTP client capabilities
Step 1: Create an account
To begin using the Oxygen Peppol API, you must first create an account. If you do not already have one, please contact our sales team to initiate the onboarding process.
Contact our sales teamStep 2: Choose your environment
Oxygen Peppol provides two distinct environments to support development and production use cases:
- Sandbox environment: Intended for development and testing. This environment allows you to validate your integration without impacting real data. The base URL is
https://sandbox-peppol.oxygen.gr. - Production environment: Intended for live, production usage. Once your integration is ready, you can switch to this environment by using the base URL
https://peppol.oxygen.gr.
WARNING
Always ensure that you are using the correct base URL and API key for the selected environment.
Step 3: Test your integration
Once authentication is configured, you are ready to make your first request to the Oxygen Peppol API. The example below demonstrates how to retrieve a list of invoices using cURL.
Remember to replace {token} with your actual API key.
curl https://sandbox-peppol.oxygen.gr/api/v1/invoices \
-H "Authorization: Bearer {token}" \Authentication
All requests to the Oxygen Peppol API must be authenticated using an API key. Authentication is performed by including your API key in the Authorization header as a Bearer token.
After your account is set up, you will be issued two API keys:
- A test key for use with the sandbox environment
- A live key for use in production
Be sure to use the appropriate key based on the environment you are accessing.
Read the documentation for the Invoices endpointWhat's next?
You are now successfully set up and have made your first request to the Oxygen Peppol API. The following resources can help you continue your integration: