|
|
|
|
|
The Isah Supply Chain Interface Webservice contains an API that can be used by third party applications. Using code (customization), other applications can call the API and send or retrieve the electronic messages Isah supports.
The Isah SCI API is a REST interface. Sending and retrieving messages takes place via HTTP requests. This chapter contains a description of the SCI API calls, using the following placeholders:
|
Supply Chain Interface Webservice address + '/api' For instance: https://servername:3097/api or https://sci.website.com:3097/api |
|
Order identification (coming from the party that created the message) |
|
Invoice identification (coming from the party that created the message) |
Order
Nr |
Cmd |
Path |
Body params |
Response body |
1. |
PUT |
<pathtoapi>/order/ |
Order |
|
2. |
GET |
<pathtoapi>/order/ |
|
List order id's |
3. |
GET |
<pathtoapi>/order/<orderid> |
|
Order |
Explanation: |
||||
1. |
Use this call to send an order to the SCI API. The body contains a valid SCSN order message. |
|||
2. |
This call asks which orders have been listed for the applicant. When successful, the response contains a list of order id's ready for retrieval (see call 3). |
|||
3. |
Retrieve an order with the specified <orderid>. When successful, the response contains an SCSN order message. |
|||
OrderResponse
Nr |
Cmd |
Path |
Body params |
Response body |
4. |
PUT |
<pathtoapi>/order/<orderid>/response |
OrderResponse |
|
5. |
GET |
<pathtoapi>/order/response/ |
|
List order id's |
6. |
GET |
<pathtoapi>/order/<orderid>/response |
|
OrderResponse |
Explanation: |
||||
4. |
Use this call to send an order response to the SCI API. The body contains a valid SCSN order response message. |
|||
5. |
This call asks which order responses have been listed for the applicant. When successful, the response contains a list of order id's for order responses ready for retrieval (see call 6). |
|||
6. |
Retrieve an order response with the specified <orderid>. When successful, the response contains an SCSN order response message. |
|||
Invoice
Nr |
Cmd |
Path |
Body params |
Response body |
7. |
PUT |
<pathtoapi>/invoice/ |
Invoice |
|
8. |
GET |
<pathtoapi>/invoice/ |
|
List invoice id's |
9. |
GET |
<pathtoapi>/invoice/<invoiceid>/ |
|
Invoice |
Explanation: |
||||
7. |
Use this call to send an invoice to the SCI API. The body contains a valid SCSN invoice message. |
|||
8. |
This call asks which invoices have been listed for the applicant. When successful, the response contains a list of invoice id's ready for retrieval (see call 9). |
|||
9. |
Retrieve an invoice with the specified <invoiceid>. When successful, the response contains an SCSN invoice message. |
|||
Despatch advice
Nr |
Cmd |
Path |
Body params |
Response body |
10. |
PUT |
<pathtoapi>/despatchadvice/ |
Despatch advice |
|
11. |
GET |
<pathtoapi>/despatchadvice/ |
|
List Despatch advice id's |
12. |
GET |
<pathtoapi>/despatchadvice/<despatchadviceid> |
|
Despatch advice |
Explanation: |
||||
10. |
Use this call to send a Despatch advice to the SCI API. The body contains a valid SCSN Despatch advice message. |
|||
11. |
This call asks which Despatch Advices have been listed for the applicant. When successful, the response contains a list of Despatch advice id's ready for retrieval (see call 12). |
|||
12. |
Retrieve a Despatch advice with the specified <despatchadviceid>. When successful, the response contains an SCSN Despatch advice message. |
|||
Authentication
The Isah SCI supports Basic authentication (user name and password) and Bearer authentication (token). The user name and password or the token must be sent along in the header of every HTTP Request.
Content type
For API calls that contain an SCSN message in the HTTP Request body the content type has to be 'text/xml'.
HTTP status codes
An HTTP Request always returns a status code, for instance:
|
Success |
The call has been executed successfully. |
|
Bad Request |
The call is incorrect. The call's content is not as expected. |
|
Unauthorized |
No access to web service. Login data is probably incorrect or has been sent incorrectly. |
|
Not Found |
The web service address is probably incorrect. |
|
Internal Server Error |
There is an error in the web service that is not caught. |