Calling the API
Public endpoint
API is listening on address https://your-website.bizwebs.com/api/graphql. Please note that every request must be sent with HTTP header Content-Type: application/json.
Request authorization
All requests must be authorized by providing a token in HTTP header. There are two types of tokens:
- website's authorization – you can create several different tokens with different access authorization levels in website's administration. Provide HTTP header named „BW-API-Key" with each request with value „Token <32-character-long-token>".
E.g. BW-API-Key:Token sFO999K9YlbLUBLZA8twFsWui5yAU7lT
Please note: the value of header must consist of static word „Token" followed by space and 32-characters long case-sensitive token. - app extension – this token is provided by integration partner/BizWebs cloud and authorizes usage of non-public API features for specific extension.
Each request must include website's authorization token otherwise HTTP 401 error code is returned. Extension-specific requests must include both website's authorization token and app extension's token. If extension's token is invalid or missing, HTTP error code 412 is returned.
Schema
See documentation or BizWebs API visualization.
You do not need to specify list of requested fields for specific entity if you use „..._<entity name>" symbolic fragment to obtain default set of fields.
Example:
<code> getOrder (order_num: „2101006"){
..._Order
}</code>
Response
<code> {
order_num: „2101006",
sum: „150 €"
} </code>