Integration via API

In this article:


    Introduction

    In this section, you'll find the developer's guide for the SOAP API in the shop system. If you want to know more about our GraphQL API that is currently in beta version, you can read more in this article.

    Note: This section requires programming experience.

    The HostedShop API makes it possible to integrate the HostedShop system with external systems, e.g. accounting systems, etc. Via the API, it is possible to fetch, create, edit and delete entities in the system.

    The HostedShop API is based on SOAP v. 1.2, which is described in this WSDL in document/literal wrapped format that is compatible with proxy tools for most major programming platforms such as PHP, Java and .NET.

    This documentation consists primarily of examples how to use the API. The first part goes through simple examples - such as connecting to the API, and various data modifications via PHP.

    The second part is a larger example in .NET, through a Visual Studio autogenerated proxy client that is accessible here.

    The complete documentation for the API is located here https://api.hostedshop.io/doc/

    Setting up the API in HostedShop

    Access to the API is disabled by default. The access can be enabled in Settings > API: SOAP. Check the box and Save to activate the API.



    Screenshot of admin


    Screenshot of admin

     

    Afterwards, an API-user is created in Settings > Employees . Note: The email does not need to be a functional email, it just needs to be unique throughout the shared shopsystem.

     

    Screenshot of admin

    The employee (in this case, the API-user) needs access to the API.
     

    Screenshot of admin

    API URL

     

    The API can be accessed here: https://api.hostedshop.io/service.wsdl