Make your first API request

Requests to Ecwid API require an access token.

After you sign up with Ecwid and get a custom app, you get two tokens — a public_token that can only be used with a few API requests but is safe to use in public code and a secret_token that supports all API requests but must be kept safe.

This guide provides a walkthrough of a basic Ecwid API interaction, specifically, retrieving store profile information. To gain a deeper understanding of Ecwid API objects and their connections, refer to the API reference.

Before you begin

There is no test mode in Ecwid API, so we recommend setting up a separate test store. This way you can safely experiment and develop without impacting your live store and its data. By isolating your testing activities, you can maintain a smooth experience for both development and production environments.

Step 1. Get your secret app token

API access to the store data is locked behind app authentication and request authorization matching the OAuth 2.0 standard.

However, we made access to your store data much more convenient. Simply open the Details page of your custom app from the app dashboard and copy its tokens for REST API requests:

If the custom app is uninstalled from the store, you’ll find the Install button here instead.

Step 2. Make your first REST API request

Now you have everything to start making REST API requests. Let's start with a simple GET request. Such requests require only two variables: store ID and access token.

You already have a custom app with access tokens. Get your store ID from any Ecwid admin page from URL or the footer.

Now make a simple “Get products” request and execute it using, for example, the Postman app.

Add store ID to the request path, your secret access token as a Bearer Token on the Authorization tab, and click Send:

That’s it. You should receive a JSON-formatted response with details about products in your store.

Next steps

Congratulations on completing the quickstart guide!

Now you can make REST API requests, so it’s time to move further.

Add more features to your custom app

Learn Ecwid API features