Getting started

Overview

This guide helps you make your first authenticated request to the 4CEE Exchange API and points you to the main features:

• Document import: upload XML and track processing status.
• Document export: list process-ready documents, fetch details, and confirm retrieval.
• Peppol functions: validate XML, check SML registrations and manage participants.
• Webhooks: get real-time notifications about document processing events.

Environments

Use Test while integrating; switch to Production when ready.

• API base URLs

  Base URLs

  • Test: https://apitest.4exchange.appCopy
  • Production: https://api.4exchange.appCopy

• Auth (token) endpoints

  • Test: https://auth-test.4exchange.app/oauth2/token
  • Production: https://auth.4exchange.app/oauth2/token

Authentication (Bearer tokens)

Obtain an OAuth 2.0 access token and send it with every request in the Authorization header.

Authorization header

Authorization: Bearer <access_token>

Client credentials

Your first API call

Try listing exportable documents.

• Method: GET
• Path: /v3/documents/export/list

Full URLs

• Test: https://apitest.4exchange.app/v3/documents/export/listCopy
• Production: https://api.4exchange.app/v3/documents/export/listCopy

Possible results

• 200 OK: JSON array with up to 100 documentIds.
• 204 No Content: nothing to export; try again later.
• 401 Unauthorized: missing/invalid token.

Common headers

• Authorization: Bearer token (required)
• Content-Type: application/json (most GET/POST returning JSON)
• For XML upload endpoints: Content-Type: application/xml

Notes

• Request size limit: 6 MB, larger requests return 413 Payload Too Large.
• Rate limiting and retries: handle 429 by backing off and retrying.
• Consistent errors: endpoints return an error JSON body with a message and appropriate HTTP status code.

Postman Collection

To help you get started quickly with our API, we have created a Postman collection that contains all the necessary endpoints and example requests. You can use this collection to test the API and understand how it works.

Note: This Postman collection is built against our test environment, so it uses the test endpoints and authentication URLs.

Download the Postman Collection

Download the Postman Collection

To use the collection:

1. Download the Postman collection using the link above.
2. Import the collection into Postman by clicking on File > Import in the Postman app.
3. Follow the instructions in the collection to configure authentication and start making requests. In the Authorization tab of Postman, set the Client ID and Client Secret as well as the appropriate Scopes required for your API requests.