web_interface:sync_api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
web_interface:sync_api [2022/02/14 14:49] – [Available calls (v5)] Gary Willettsweb_interface:sync_api [2025/01/21 23:18] (current) – [Basics] Mark Glover
Line 1: Line 1:
 {{indexmenu_n>100}} {{indexmenu_n>100}}
-====== 19.10. mSupply sync API ======+====== 19.11. mSupply sync API ======
 ===== What is it? ===== ===== What is it? =====
 There are multiple ways to configure an mSupply installation. Where the internet is good, or you are using a local area network, you can have real-time communication with an mSupply server. Where internet access is poor or non-existent, we have mSupply sync. You can have a local application that saves all the changes the user makes to a local database - this can be a mobile app, a single user application on a PC or a tablet, or a client-server application on a local LAN.  There are multiple ways to configure an mSupply installation. Where the internet is good, or you are using a local area network, you can have real-time communication with an mSupply server. Where internet access is poor or non-existent, we have mSupply sync. You can have a local application that saves all the changes the user makes to a local database - this can be a mobile app, a single user application on a PC or a tablet, or a client-server application on a local LAN. 
  
-The machine on which the data is stored, which we call a //satellite//, then periodically communicates with a central mSupply server, which we call the //primary// - this may be in a central location in the country, or it may be a cloud-based server. The REST API described here is used to send and receive data from the primary server to keep both satellite and primary sites up to date with data additions, modifications and deletions. See [[other_stuff:remote_sync|Remote Synchronisation]] for more details on how sync works.+The machine on which the data is stored, which we call a //satellite//, then periodically communicates with a central mSupply server, which we call the //primary// - this may be in a central location in the country, or it may be a cloud-based server. The REST API described here is used to send and receive data from the primary server to keep both satellite and primary sites up to date with data additions, modifications and deletions. See [[synchronisation:introduction|]] for more details on how sync works.
  
 ===== Basics ===== ===== Basics =====
 You might want to read about our [[web_interface:apis|mSupply Mobile API]], as the basics are the same. That is: You might want to read about our [[web_interface:apis|mSupply Mobile API]], as the basics are the same. That is:
  
-  - The SYNC API is a subset of the mSupply REST API.+  - The SYNC API is a subset of the [[web_interface:rest_api|mSupply REST API]].
   - All calls to the sync API use a pseudo-resource of "sync".   - All calls to the sync API use a pseudo-resource of "sync".
   - The second URI segment is the API version. Allowable values:   - The second URI segment is the API version. Allowable values:
Line 232: Line 232:
 === central_records === === central_records ===
 <code>https://example.com/sync/v5/central_records?cursor=0&limit=1000</code> <code>https://example.com/sync/v5/central_records?cursor=0&limit=1000</code>
-Requests sync records waiting to be processed for the sync site matching the authentication sent in the header.+Requests sync change log records for the sync site matching the authentication sent in the header.
  
 == Attributes == == Attributes ==
   * **cursor**: the record number to return from. e.g. ''cursor=10'' means start returning from the 10th record onwards.   * **cursor**: the record number to return from. e.g. ''cursor=10'' means start returning from the 10th record onwards.
-  * **limit**: the maximum number of records that can be returned. If ommitted, the //limit// is set to 1000. If a //limit// value above 1000 is used, the //limit// is set to 1000.+  * **limit**: the maximum number of records that can be returned. If omitted, the //limit// is set to 1000. If a //limit// value above 1000 is used, the //limit// is set to 1000.
  
 === queue === === queue ===
Line 248: Line 248:
 \\ \\
 \\ \\
-|  //  Previous:  **[[web_interface:apis]]** | | Next: **[[cold_chain_equipment:]]** //  |+|  //  Previous:  **[[web_interface:apis]]** | | Next: **[[web_interface:unfpa_reports_app]]** //  |
 ---- struct data ---- ---- struct data ----
 pagestatus.status    :  pagestatus.status    : 
 ---- ----
  
  • Last modified: 2022/02/14 14:49
  • by Gary Willetts