Incremental Sync

This section shows how to implement a strategy to download only the new received Peppol documents from My Azur API and the the list of sent document that changed their statuses.

It is important to adopt an efficient strategy for downloading Peppol documents from My Azur API. In this chapter, we will see how to maintain a client-side timestamp of the last sync performed and how to request from My Azur API the list of documents following that timestamp.

We start by requesting the list of all received documents (First sync, no previous requests).

curl --location 'https://api-sandbox.myazur.app/folders/<folder_id>/documents?incoming=true&status_changed_after=2022-09-23T15%3A26%3A27.193661' \
--header 'Authorization: Bearer <Firebase Token>

Get the full list of received documents

We'll get the list of documents in JSON format as following:

{
    "created_at": "2024-01-09T15:56:58.059944",
    "objects": [
        {
            "created_at": "2023-10-04T21:56:19.931579",
            "created_by": "abc123-def456-ghi789-jkl012",
            "folder_id": 5,
            "id": 6,
            "incoming": true,
            "response_status_id": 1,
            "status_id": 1,
            "updated_at": "2023-10-04T21:56:19.931579",
            "updated_by": "abc123-def456-ghi789-jkl012"
        },
        {
            "created_at": "2023-10-19T12:38:23.314652",
            "created_by": "abc123-def456-ghi789-jkl012",
            "folder_id": 5,
            "id": 11,
            "incoming": true,
            "response_status_id": 1,
            "status_id": 1,
            "updated_at": "2023-10-19T12:38:23.314652",
            "updated_by": "abc123-def456-ghi789-jkl012"
        },
        ....
        ....
    ]
}

We get a list of objects and the created_at timestamp. We should save this timestamp as last synced at timestamp. To request the new received documents we'll send the saved timestamp as query arg in the next request as following:

curl --location 'https://api-sandbox.myazur.app/folders/<folder_id>/documents?incoming=true&status_changed_after=2024-01-09T15%3A56%3A58.059944'
--header 'Authorization: Bearer <Firebase Token>

Fetch only the new Peppol Documents (Incremental Sync)

The same strategy can be used to fetch the list of sent documents that changed their statuses. Initially when you submit a document it gets a status_id = 1 (Submitted). You are supposed to periodically check for status change by sending the request illustrated above with the query arg incoming = false. You'll get all the documents that you previously sent that changed status.