ESO9 wiki

Uživatelské nástroje

Nástroje pro tento web

Umístění: start » peppol » publicrestapi
Historie:
peppol:publicrestapi

Rozdíly

Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.

Odkaz na výstup diff

peppol:publicrestapi [24.03.2026 08:31] – vytvořeno turychpeppol:publicrestapi [24.03.2026 08:37] (aktuální) – turych
Řádek 1: Řádek 1:
-====== Public REST API ======+====== REST API ======
  
 ===== Test Access Point URL ===== ===== Test Access Point URL =====
Řádek 11: Řádek 11:
 ===== Basic communication verification ===== ===== Basic communication verification =====
  
-  * //URL:// %7B%7BURL%7D%7D/api/auth/whoami+  * //URL:// {{URL}}/api/auth/whoami
   * //HTTP method:// GET   * //HTTP method:// GET
   * //Authentication:// no   * //Authentication:// no
Řádek 21: Řádek 21:
 ===== Authentication ===== ===== Authentication =====
  
-  * //URL:// %7B%7BURL%7D%7D/api/auth+  * //URL:// {{URL}}/api/auth
   * //HTTP method:// POST   * //HTTP method:// POST
   * //Authentication:// no   * //Authentication:// no
Řádek 46: Řádek 46:
 </code> </code>
  
-  * //statusCode:// HTTP status, e.g. 200 (OK).+  * //statusCode:// HTTP status, e.g. 200 (OK).
   * //message:// Bearer token used for authentication of SEND / RECEIVE methods. Token is valid for 24 hours. Error description if authentication fails.   * //message:// Bearer token used for authentication of SEND / RECEIVE methods. Token is valid for 24 hours. Error description if authentication fails.
   * //errorCode:// Error Code if authentication fails.   * //errorCode:// Error Code if authentication fails.
Řádek 65: Řádek 65:
 Validates and sends one document. Validates and sends one document.
  
-  * //URL:// %7B%7BURL%7D%7D/api/peppol/send+  * //URL:// {{URL}}/api/peppol/send
   * //HTTP method:// POST   * //HTTP method:// POST
   * //Authentication:// Bearer token obtained by calling the ''%%AUTH%%'' method   * //Authentication:// Bearer token obtained by calling the ''%%AUTH%%'' method
Řádek 71: Řádek 71:
     * Accept: ''%%*/*%%''     * Accept: ''%%*/*%%''
     * Content-Type: application/xml     * Content-Type: application/xml
-    * Authorization: Bearer 89puKGci… +    * Authorization: Bearer 89puKGci… 
-    * X-PEPPOL-RECEIVER: PEPPOL recipient’s ID (aka ParticipantID), e.g.''%%9929:CZ27624609%%''+    * X-PEPPOL-RECEIVER: PEPPOL recipient’s ID (aka ParticipantID), e.g.''%%9929:CZ27624609%%''
     * X-PEPPOL-DOC-TYPE: type of document being sent, e.g.''%%Generic.Invoice%%'' or ''%%Generic.CreditNote%%''     * X-PEPPOL-DOC-TYPE: type of document being sent, e.g.''%%Generic.Invoice%%'' or ''%%Generic.CreditNote%%''
   * //Body:// document in PEPPOL BIS 3.0 format   * //Body:// document in PEPPOL BIS 3.0 format
Řádek 85: Řádek 85:
 </code> </code>
  
-  * //statusCode:// HTTP status, e.g. 200 (OK)+  * //statusCode:// HTTP status, e.g. 200 (OK)
   * //message:// created document ID on Access Point. Error description if sending fails.   * //message:// created document ID on Access Point. Error description if sending fails.
   * //errorCode:// Error Code if sending fails.   * //errorCode:// Error Code if sending fails.
Řádek 96: Řádek 96:
 --header 'X-PEPPOL-DOC-TYPE: Generic.Invoice' \ --header 'X-PEPPOL-DOC-TYPE: Generic.Invoice' \
 --header 'Content-Type: application/xml' \ --header 'Content-Type: application/xml' \
---header 'Authorization: Bearer ••••••' \+--header 'Authorization: Bearer â€˘â€˘â€˘â€˘â€˘â€˘' \
 --data-raw '<ns4:Invoice xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" .... ' --data-raw '<ns4:Invoice xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" .... '
 </code> </code>
Řádek 104: Řádek 104:
 Receipt of a single document. Receipt of a single document.
  
-  * //URL:// %7B%7BURL%7D%7D/api/peppol/receive+  * //URL:// {{URL}}/api/peppol/receive
   * //HTTP method:// GET   * //HTTP method:// GET
   * //Authentication:// Bearer token obtained by calling the ''%%AUTH%%'' method   * //Authentication:// Bearer token obtained by calling the ''%%AUTH%%'' method
Řádek 110: Řádek 110:
     * Accept: ''%%*/*%%''     * Accept: ''%%*/*%%''
     * Content-Type: application/xml     * Content-Type: application/xml
-    * Authorization: Bearer 89puKGci…+    * Authorization: Bearer 89puKGci…
     * X-PEPPOL-DOCUMENT-ID: document ID retrieved from webhook (''%%IDPEPPOLDOC%%'' in ESO9 table ''%%PEPPOL_DOC_QUEUE%%'')     * X-PEPPOL-DOCUMENT-ID: document ID retrieved from webhook (''%%IDPEPPOLDOC%%'' in ESO9 table ''%%PEPPOL_DOC_QUEUE%%'')
   * //Body:// none   * //Body:// none
Řádek 125: Řádek 125:
 </code> </code>
  
-  * //statusCode:// HTTP status, e.g. 200 (OK)+  * //statusCode:// HTTP status, e.g. 200 (OK)
   * //document:// document in PEPPOL BIS 3.0 format   * //document:// document in PEPPOL BIS 3.0 format
   * //errorCode:// Error Code if sending fails.   * //errorCode:// Error Code if sending fails.
Řádek 134: Řádek 134:
 curl --location '{URL}/peppol/receive' \ curl --location '{URL}/peppol/receive' \
 --header 'X-PEPPOL-DOCUMENT-ID: 9999' \ --header 'X-PEPPOL-DOCUMENT-ID: 9999' \
---header 'Authorization: Bearer ••••••'+--header 'Authorization: Bearer â€˘â€˘â€˘â€˘â€˘â€˘'
 </code> </code>
  
Řádek 141: Řádek 141:
 Retrieves a list of all documents (sent and received) without including their payload. Retrieves a list of all documents (sent and received) without including their payload.
  
-  * //URL:// %7B%7BURL%7D%7D/api/peppol/documents?from=2026-01-01T15:00:00&to=2026-02-15T00:00:00+  * //URL:// {{URL}}/api/peppol/documents?from=2026-01-01T15:00:00&to=2026-02-15T00:00:00
   * //HTTP method:// GET   * //HTTP method:// GET
   * //Parameters:// from / to - document creation date and time (from / to)   * //Parameters:// from / to - document creation date and time (from / to)
Řádek 148: Řádek 148:
     * Accept: ''%%*/*%%''     * Accept: ''%%*/*%%''
     * Content-Type: application/xml     * Content-Type: application/xml
-    * Authorization: Bearer 89puKGci…+    * Authorization: Bearer 89puKGci…
   * //Body:// none   * //Body:// none
   * //Returns:// JSON in structure:   * //Returns:// JSON in structure:
Řádek 180: Řádek 180:
 </code> </code>
  
-  * //statusCode:// HTTP status, e.g. 200 (OK)+  * //statusCode:// HTTP status, e.g. 200 (OK)
   * //message:// list of all documents associated with the specified entity   * //message:// list of all documents associated with the specified entity
   * //errorCode:// Error Code if sending fails.   * //errorCode:// Error Code if sending fails.
Řádek 188: Řádek 188:
 <code bash> <code bash>
 curl --location 'https://peppol.eso9.cz/accesspoint/api/peppol/documents?from=2026-01-01T15%3A00%3A00&to=2026-02-15T00%3A00%3A00' \ curl --location 'https://peppol.eso9.cz/accesspoint/api/peppol/documents?from=2026-01-01T15%3A00%3A00&to=2026-02-15T00%3A00%3A00' \
---header 'Authorization: Bearer ••••••'+--header 'Authorization: Bearer â€˘â€˘â€˘â€˘â€˘â€˘'
 </code> </code>
  
 ===== Retrieval of previously undownloaded documents ===== ===== Retrieval of previously undownloaded documents =====
  
-Retrieves a list of documents with the status “not yet downloaded” in the Access Point.+Retrieves a list of documents with the status â€śnot yet downloaded” in the Access Point.
  
-  * //URL:// %7B%7BURL%7D%7D/api/peppol/undownloaded+  * //URL:// {{URL}}/api/peppol/undownloaded
   * //HTTP method:// GET   * //HTTP method:// GET
   * //Authentication:// Bearer token obtained by calling the ''%%AUTH%%'' method   * //Authentication:// Bearer token obtained by calling the ''%%AUTH%%'' method
Řádek 201: Řádek 201:
     * Accept: ''%%*/*%%''     * Accept: ''%%*/*%%''
     * Content-Type: application/xml     * Content-Type: application/xml
-    * Authorization: Bearer 89puKGci…+    * Authorization: Bearer 89puKGci…
   * //Body:// none   * //Body:// none
   * //Returns:// JSON in structure:   * //Returns:// JSON in structure:
Řádek 222: Řádek 222:
 </code> </code>
  
-  * //statusCode:// HTTP status, e.g. 200 (OK)+  * //statusCode:// HTTP status, e.g. 200 (OK)
   * //message:// list of undownloaded documents associated with the specified entity   * //message:// list of undownloaded documents associated with the specified entity
   * //errorCode:// Error Code if sending fails.   * //errorCode:// Error Code if sending fails.
Řádek 230: Řádek 230:
 <code bash> <code bash>
 curl --location 'https://peppol.eso9.cz/accesspoint/api/peppol/undownloaded' \ curl --location 'https://peppol.eso9.cz/accesspoint/api/peppol/undownloaded' \
---header 'Authorization: Bearer ••••••'+--header 'Authorization: Bearer â€˘â€˘â€˘â€˘â€˘â€˘'
 </code> </code>
  
peppol/publicrestapi.txt · Poslední úprava: 24.03.2026 08:37 autor: turych
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki
DokuWiki Appliance - Powered by TurnKey Linux