For all developers

See also the examples in .NET and HTTP request/JSON in the OM section of this documentation OM (object model)


This document explains how to use the WinBooks on Web API through the HTTP request and it gives also the corresponding .NET code using the Winbooks.Apis.Services.

For .NET developers

For .NET developpers

If you develop in .NET, we suggest that you use the Winbooks.Apis.Services as it is easier to use the WinBooks on Web API through this way.

We invite you to read the document Use the Winbooks.Apis.Services.

When client is granted rights to access folder, client and REST API can make a "communication" for query, insert, update and delete data.

In our REST API, the small unit of data is an object. Each object has a unique URL so client and API are able to know what object they are "talking" about. For a recap:

URL for single data:

Formula:  { REST API Host }  / app /  { Winbooks OM }  /  { Code }  /  Folder /  { FolderCode }

Example:    https://rapi.winbooksonweb.be  / app /  Customer   SARA   Folder   PARFIWEB_DEMO

URL for plural data:

Formula:    { REST API Host }  / app /  { Winbooks OMS }    Folder   { FolderCode } 

Example:    https://rapi.winbooksonweb.be   / app /  Customers    Folder   PARFIWEB_DEMO

 Every request needs to include access token in header that follows the below format:

Authorization :  Bearer {access_token}

  • No labels