Getting started with the SyncSketch API

Unlock the potential of connecting your own apps and scripts to SyncSketch

You want to integrate SyncSketch more closely into your existing pipeline?

We offer a fully-featured API through which all commands on SyncSketch can be called programmatically.  

If you have more questions, don't hesitate to ask us at support@syncsketch.com.

The SyncSketch API is currently available only to accounts that are on an Enterprise plan.

Get Started

Please find the complete API documentation on our dedicated site here:

https://api.syncsketch.com

Download the Python API here:
https://github.com/syncsketch/python-api

Getting your credentials

To start using this API, you will need your API Username and API Key, which you can find near the bottom of:

User Profile > Settings > Developer Info

https://syncsketch.com/pro/#/userProfile/settings

DeveloperInfoRotatedKeyFullPage

The moment you generate an API key is the last time you will ever see it in SyncSketch.  Be sure to click the Copy button (clipboard icon) and store it in a secure location.

Tip: Your API key can change from time to time, so don't hard-code it into anything if you can avoid it.  Instead, store it as an environment variable on your development system or in your REST API development environment.

Key Rotation

The next time you open your User Profile, the API key will not be readable and cannot be copied.  There is no way to recover your API key, but you can generate a new one with the Rotate API Key button:

DeveloperInfo

After clicking this button, you will be advised that any script or tool referencing the old API key will need to be updated.  Then you will have the opportunity to copy the new API key and store it securely.

The API Key Age field indicates how long it has been since the last key rotation.  Best security practice is to rotate your API key annually, quarterly or monthly depending on your organization's information security policy.

Troubleshooting

I don't have a Developer Info section!

If you do not see a Developer Info section, you will need to upgrade to an Enterprise plan.  If you are on an Enterprise plan and you do not see this section, contact us at support@syncsketch.com.

I've lost my API Key!

See the section above about Key Rotation.