The Syncari Embed APIs follow the REST API architecture. Using the REST APIs, integrate, connect and manage the resources (such as Synapses, Quick Starts, and Pipelines) of a Syncari organization by making HTTP requests to URLs that represent those resources. See the API Reference section for a list of all resources and their operations.
Set up an API User
To send a request to the Syncari Embed APIs, use the API credentials of a Syncari user with API access. Your app will exchange those credentials for an access token to use for subsequent requests.
- See API Credentials for the steps to set up an API user in Syncari and retrieve the API credentials.
- See Authentication to learn how to authenticate with Syncari.
Make HTTP Requests
To perform operations on a resource, make an HTTP request to the URL of the specific resource, called the endpoint. Send the request to the Syncari Embed Base URL and include the method, appropriate headers (most importantly, the access token), request body, and query parameters.
Here’s a sample request to retrieve the list of Synapses.
curl --location --request GET 'https://api.syncari.com/api/v1/synapses' --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLC........'
More Info
- Find detailed information about each Syncari Embed resource in the API Reference Documentation.
- See the Syncari Embed Base URL.
HTTP Methods
Syncari Embed APIs support the primary HTTP methods: POST, GET, PUT, PATCH, and DELETE. These methods correspond to create, read, update, and delete (or CRUD) operations.
| HTTP METHOD | CRUD OPERATION | DESCRIPTION |
|---|---|---|
| GET | Read | The GET method requests a representation of the specified resource. Requests using GET should only retrieve data. |
| POST | Create | The POST method submits an entity to the specified resource, often causing a change in state or side effects on the server. |
| PATCH | Update | The PATCH method applies partial modifications to a resource. |
| DELETE | Delete | The DELETE method deletes the specified resource. |
| PUT | Update/replace | The PUT method replaces all current representations of the target resource with the request payload. |
Headers
You use HTTP headers to specify additional information about the call. All headers must include an access token, except the requests to acquire or refresh an access token.