REST API

This site offers a small REST API to perform arbitrary PEPPOL SMP lookups with a JSON result. The API is proprietary. The result data format is proprietary JSON.

Base parameters

The base URL for all REST queries is https://peppol.helger.com/api - prepend this to all queries.
If an SML is required, the following SML identifiers are available:
  • digitprod - the production PEPPOL SML
  • digittest - the test PEPPOL SML (aka SMK)
  • id40 - the pilot TOOP SML (aka SMK)
  • autodetect - find the matching SML automatically

API: SMP query all document types of a participant

To retrieve all document types from a participant, use the following URL layout:

/smpquery/SML-ID/participant-ID[?businessCard=true]
SML-ID is the SML identifier mentioned above.
participant-ID is the URL encoded participant identifier to be queried (e.g. iso6523-actorid-upis%3a%3a9915%3atest)
If the optional parameter businessCard=true is added, the SMP Business Card is queried as well.

Example URL: /smpquery/digittest/iso6523-actorid-upis%3a%3a9915%3atest

Note: all SMP queries are passed through to the effective SMP server and cause load there.

API: SMP query all endpoints of a participant for a certain document type

To retrieve all endpoints from a participant for a single document type, use the following URL layout:

/smpquery/SML-ID/participant-ID/docType-ID
SML-ID is the SML identifier mentioned above.
participant-ID is the URL encoded participant identifier to be queried (e.g. iso6523-actorid-upis%3a%3a9915%3atest)
docType-ID is the URL encoded document type identifier to be queried (e.g. busdox-docid-qns%3A%3Aurn%3Aoasis%3Anames%3Aspecification%3Aubl%3Aschema%3Axsd%3AInvoice-2%3A%3AInvoice%23%23urn%3Awww.cenbii.eu%3Atransaction%3Abiitrns010%3Aver2.0%3Aextended%3Aurn%3Awww.peppol.eu%3Abis%3Apeppol5a%3Aver2.0%3A%3A2.1)

Example URL: /smpquery/digittest/iso6523-actorid-upis%3a%3a9915%3atest/busdox-docid-qns%3A%3Aurn%3Aoasis%3Anames%3Aspecification%3Aubl%3Aschema%3Axsd%3AInvoice-2%3A%3AInvoice%23%23urn%3Awww.cenbii.eu%3Atransaction%3Abiitrns010%3Aver2.0%3Aextended%3Aurn%3Awww.peppol.eu%3Abis%3Apeppol5a%3Aver2.0%3A%3A2.1

Note: all SMP queries are passed through to the effective SMP server and cause load there.

API: SMP query the Business Card of a participant

To retrieve the Business Card of a participant, use the following URL layout:

/businesscard/SML-ID/participant-ID
SML-ID is the SML identifier mentioned above.
participant-ID is the URL encoded participant identifier to be queried (e.g. iso6523-actorid-upis%3a%3a9915%3atest)

Example URL: /businesscard/digittest/iso6523-actorid-upis%3a%3a9915%3atest

Note: the layout of the BusinessCard JSON is identical to the one used in querying all document types of a participant.

Note: all SMP queries are passed through to the effective SMP server and cause load there.

You must be logged in to post a comment!