Siteshop Integration Cloud – JSON Web Services V3
Data can be sent to Integration Cloud using our JSON Web Service API.
Below you will find the description on how that API works.
Request
The request is a POST call, that carries a payload and the necessary headers for the web service to understand the call.
Web service URL
https://ws.siteshop.eu/SicImportREST/sicapi/v3/Import
Headers
Datatype | Select one from a the list below |
IntegrationId | Unique id for the customer’s specific integration |
Authorization
The service uses a Bearer Token with JWT method. Use Postmand or your favorite variant to test the auth, most of tools like this have a UI option for configuring Bearer Token auth.
To generate the JWT, refer to the document sent separately “Sic_Import_REST_Authenticator_V3.docx”.
Body
The body should be a JSON formatted request, containing one or more of the same type datatype (Compan/Person/etc.)
Example for sending a single Company, with a few extra fields:
{
"Company":[
{
"IntegrationId": "17PS01010001",
"CompUserKey01": "Key123",
"Name": "Siteshop ApS",
"CVR": "21252832",
"CompUserCheck01": true,
"CompUserNum01": 42,
"CompUserDec01": 150.49,
"IntegrationIdCheck": "17PS01010001"
}
]
}
Example for sending multiple Companies:
{
"Company":[
{
"IntegrationId": "17PS01010001",
"Name": "Siteshop ApS",
"CompUserKey01": "Key123",
"IntegrationIdCheck": "17PS01010001"
},
{
"IntegrationId": "17PS01010001",
"Name": "Lego ApS",
"CompUserKey01": "4280",
"IntegrationIdCheck": "17PS01010001"
}
]
}
Additional request information
- It’s not possible to send mulitple different datatype elements in the same call
- All fields marked as mandatory in the field list must be included in the JSON
- Full list of supported fields can be found here
Response
The response will consist of an HTTP Status Code and a response content. The content will carry additional information, either for error reporting or other details.
Responses might look like this:
Only properties that have data, are ever show. So in the first screenshot, “details” is hidden, as no relevant information is there. Here are the names of all potential properties currently supported:
- message
- details
- errorCode
There are several options for how the service might respond, depending on the particular error. It is generally recommended to examine the response content, to get more details, particularly in an error response. A few common response status codes include:
HTTP Status | Cause |
200 Ok | The request was handled normally |
400 Bad Request | The request was not valid, perhaps a header is missing |
401 Unauthorized | The request was not authorized |
404 Not Found | The IntegrationId might be incorrect |
Datatypes
- Appointment
- Company
- CompanyInterest
- Document
- Person
- PersonInterest
- PriceList
- ProjectMember
- Product
- Project
- Relation
- Sale
- NormalTable01
- RelationTable01
- NormalTable02
- RelationTable02
- NormalTable03
- RelationTable03
- NormalTable04
- RelationTable04
- NormalTable05
- RelationTable05
- ProtectedPerson