SCI Australia: API Interfaces

API Interfaces

WHAT IS AN API

An API (Application Programming Interface) is a method of standardising interaction between multiple softwares. Because most softwares and programming languages have very different methods of action and implementation, a bridge needs to be built to accomodate common interaction. This bridge is the backbone of API software.


HOW DOES IT WORK

Unlike tranditional forms of B2B data interfacing, APIs provide unlimited, real time, responsive sampling of data. Where EDI traditionally involved CSV or XML data to be sent and received to clients at specified intervals, APIs allow a client to access a servers database at any given time with tailored parameters and outputs. With basic requests our clients databases can be kept up to date with valuable order information, including but not limited to:

  • Supply Readiness (Ex Factory)
  • Vessel Name
  • Voyage Number
  • ETD
  • ETA
  • Customs Status
  • Delivery Dates



REST

In REST API design, client and server applications are completely independent of each other. The only information the client application should know is the URI of the requested resource; it can't interact with the server application in any other way. REST has been a modern standard to its flexibility and ease of use.


For our REST APIs please use the below:

URI / URL Touchpoint: https://www.sciaustralia.com/restapi/v1/

Documentation: https://documenter.getpostman.com/view/12949778/UUxtFAc2

Request Example: https://www.sciaustralia.com/restapi/v1/Orders/

Response Sample JSON: https://www.sciaustralia.com/restapi/v1/rest-v1-response.json

SOAP

Unlike the REST design, SOAP requires the client to send an XML data format to a URI to declare a request. Depending on the schema structure the server will return a specific response. SOAP has been a messaging standard for a long time due to its rigidity and uncompromising structure.


For our SOAP API please see the below:

URL Touchpoint: https://www.sciaustralia.com/soapapi/v1/

WSDL: https://www.sciaustralia.com/soapapi/v1/WSDL

Request Sample XML: https://www.sciaustralia.com/soapapi/v1/request_sample.xml

Response Sample XML: https://www.sciaustralia.com/soapapi/v1/response_sample.xml

For any authorization codes please contact:

IT Support: administrator@sciaustralia.com

Developed by SCI Productions Pty Ltd || © 2015 - 2021