• How do I get started with the API?

    To connect to our API, head over to your Spreadconnect App and go to:

    1. Integrations on the left-hand side menu.
    2. Connect under the Spreadconnect API section.

    Once you click on Connect, our system will prepare the API-based integration and will redirect you to your Spreadconnect App Dashboard. There, you will find your API Key. This Key can also be found in your Integration Settings.

    APIgif.gif

    You are now ready to start programming your store on your website with the help of Spreadconnect API Documentation.

    A few tips before you continue:

    • Make sure to add your payment method in your Spreadconnect App only when are ready to receive and/or place real orders. Otherwise, your test orders may end up being printed and shipped.
    • The API Key we created for you is unique and should not be shared. Be sure to keep it secret and not expose it online (ex: Github).

    Once your side of the integration has been programmed correctly, you can start creating and publishing products from your Spreadconnect App to your own store.

  • How Does the Staging Area Work for Rest API?

    Spreadconnect has a test environment called the Staging Area which lets you try out your integration and order processes.

     

    To use this feature, you will need to register an account for the Staging Area. Your usual Spreadconnect credentials will not work. You will also need to enter test credit card information. You can use these test credit card numbers. The staging area lets you create orders and simulate orders going into production and being shipped.

     

    To do this you can create an order via your respective integration or by creating sample or manual orders. When creating the test order it’s best to create orders above $300/€300 in order to circumvent batching .

    Once the order is created, go to the order detail page and on the top left under More Actions click Simulate Order State in Production. You can now see what an order looks like when it goes into production. Select More Actions again and click Simulate Order State Sent.

    This will make your order look like it has been shipped and will generate a tracking number.

     

    Read up here  how to best make use of the staging environment.