Sync Reference

All requests to the Sync API endpoints must be authenticated. You can easily reuse access tokens you might have used during the calls to the REST API. Just make sure they’re tagged with the sync permission scope.

In addition to theAuthorizationheader, you must provide the UUID for the device for which you want to perform synchronization, within theX-Basecrm-Device-UUID. The UUID must not change between synchronization sessions. There is a limit of100active synchronization sessions.

             

              
Authorization: Bearer $ACCESS_TOKENX-Basecrm-Device-UUID: $CLIENT_DEVICE_UUID
             

---

Start Synchronization Flow

             

              
POST/v2/sync/start
             

这是第一个端点打电话,to start a new synchronization session.

If you get a204response, there is nothing new to download and you can safely stop the flow. If there is data to synchronize, you will get a201response.

The response is the synchronization session object with an embedded array of queues.

Thesync_sessionobject will include the following fields:

Thesync_queuefields:

Allowed for

• Agents
• Admins

Using curl

             

              
旋度-v -X POST https://api.getbase.com/v2/sync/start\-H"Accept: application/json"\-H"X-Basecrm-Device-UUID:$CLIENT_DEVICE_UUID"\-H"Authorization: Bearer$ACCESS_TOKEN"
             

Example Response

             

              
HTTP/1.1201CreatedContent-Type:application/json{"data":{"id":"$SESSION_ID","queues":[{"data":{"name":"main","pages":1,"total_count":2},"meta":{“类型”:"sync_queue","links":{"self":"https://api.getbase.com/v2/sync/$SESSION_ID/queues/main"}}}]},"meta":{“类型”:"sync_session"}}
             

---

Get data from queue

             

              
GET/v2/sync/:session_id/queues/main
             

Fetch fresh data from the main queue.

The queue holds only the freshest data, there are no historical data stored. Only to make a point, imagine a case when, between synchronization sessions, someone creates a lead and then updates its representation. You will get only the freshest data for the lead.

Deleted resources will include only ids, and you should treat it as an instruction to perform local delete.

Once there is no more data to synchronize you will get a204response, otherwise you get200.

A successfull response will include an array of resources, you are already fimiliar with, and additional Sync related attributes withinmeta/syncobject.

The syncmetaobject fields:

The top levelmetaattribute includes a few attributes that may hint your syncing process.

failed_objectsis a list of items which should have been included but for some reasons weren’t. Every item has these attributes attached:

Examplefailed_objectsmight look like:

             

              
[{“类型”:“协议”,"id":1},{“类型”:"lead","id":2}]
             

Allowed for

• Agents
• Admins

Using curl

             

              
旋度-v -X GET https://api.getbase.com/v2/sync/:session_id/queues/main\-H"Accept: application/json"\-H"X-Basecrm-Device-UUID:$CLIENT_DEVICE_UUID"\-H"Authorization: Bearer$ACCESS_TOKEN"
             

Example Response

             

              
HTTP/1.1200OKContent-Type:application/json{"items":[{"data":{"id":1,"creator_id":1,"name":"Our website","updated_at":"2015-05-07T11:44:01Z","created_at":"2014-08-27T16:32:57Z"},"meta":{“类型”:"source","sync":{"event_type":"updated","ack_key":"Source-976368-1375200190","revision":1375200190}}},{"data":{"id":3},"meta":{“类型”:"source","sync":{"event_type":"deleted","ack_key":"Source-976369-0","revision":0}}}],"meta":{“类型”:"collection","count":2,"count_left":0,"failed_objects":[]}}
             

---

Acknowledge received data

             

              
POST/v2/sync/ack
             

Send acknowledgement keys, to let the Sync service know which data you have.

Sent acknowledgement keys are processed in a background, so if some acks are left out for processing and you start another synchronization flow you might get data from a previous session.

Allowed for

• Agents
• Admins

Using curl

             

              
旋度-v -X POST https://api.getbase.com/v2/sync/ack\-H"Content-Type: application/json"\-H"X-Basecrm-Device-UUID:$CLIENT_DEVICE_UUID"\-H"Authorization: Bearer$ACCESS_TOKEN"\-d'{"data": {"ack_keys": ["Source-976368-1375200190","Source-976369-0"]}}'
             

Example Response

             

              
HTTP/1.1202Accepted