How do I make my first API call?

How to make your first call

How does your API work?

We use REST. We have a staging and a production site:

1. Staging: Swagger UI
2. Production: Swagger UI

We publish changes to staging, QA tests and we publish. We recommend starting with the staging site first because it gets all the latest changes. 

How do I make my first API call?

In this example, we will get a list of user connections. This should return a single record for the custom store. Here are the steps:

1. Log into Connex.
2. Go to connections.
3. Add the custom store connection.
4. In the settings for custom store, click generate token.
5. Go to our staging swagger endpoint.
6. On the top right, click authorize.
7. Enter bearer, a space and your access token.
8. Go to userconnections/list.
9. Click try it out.
10. Click execute.

If I want to sync orders from a back office system to my selling channel, what API call should I use?

Use the ListOrdersWithOrderItemsAndFilter call. You will receive customer details and order items.

I want to sync product updates from my software to Connex. What API call should I use?

Here are the steps:

1. Use the UpdateProducts API call.
2. Log into Connex.
3. Click connections.
4. Add the back office system, like Amazon.
5. Under Amazon settings, click products and enable sync from Connex to Amazon.
6. Connex will sync product updates to your selling channel on a scheduled basis.

Do you have other sample API calls?

For more info, read this guide.

🔷 Next: Purchase Licenses