IBM Supply Chain Shared Ledger Input API

Preview

IBM Supply Chain Shared Ledger Input API

+ Day(s) remaining in the trial

Overview

# IBM Supply Chain Shared Ledger data input API Allows X12 EDI data to be submitted to IBM Supply Chain Shared Ledger

Getting started

Authentication

To call IBM Supply Chain Shared Ledger APIs, you need to have a subscription to Shared Ledger and you need to use the HTTP header fields (X-IBM-Client-Secret and X-IBM-User-Secret) for authentication.

Calling the API

Use the INPUT API to send documents to the shared ledger. The following procedure explains how to use a simple cURL command with the input REST API to send a request with your X12 EDI document. You can use cURL to test that you can successfully send documents. Then, determine the best method to share documents from your system. For example, creating your own classes and methods to integrate and share. 1. Go to the Security section to find your X-IBM-Client-Secret and X-IBM-User-Secret. 2. Go to the Documentation section to find the URL that you can use to POST your X12 EDI documents. For example, https://dev.api.ibm.com/scsharedledgers/api/input/v1/{CompanyId}/doc. If you do not know your CompanyID, then complete the following steps. 1. Log in to [IBM Sterling Customer Center](https://cn.sterlingcommerce.com). 2. Under Administration, select My Company. 3. Copy the SCI Company ID field. 3. Use your method of choice to POST documents. For example, if you use cURL, your request might look similar to the following call. curl --request POST --url "https://dev.api.ibm.com/scsharedledgers/development/api/input/v1/ODCO04112376/doc?alias=testAlias&direction=inbound&documentid=testDocId&processed=2018-05-23T18:14:14Z" --header 'accept: application/json' --header 'content-type: application/octet-stream' --header 'x-ibm-client-id: ' --header 'x-ibm-client-secret: ' --data-binary @''"

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Documentation

IBM Supply Chain Shared Ledger Input API:

input

Submits X12 EDI document data to IBM Supply Chain Shared Ledger
/input/v1/{CompanyId}/doc - POST

POST   /input/v1/{CompanyId}/doc

			https://api.ibm.com/scsharedledgers/run/api/input/v1/{CompanyId}/doc
		
Keys
Path and Query parameters

alias

STRING , required

The ledger name as displayed in IBM Supply Chain Shared Ledger. This value is case-sensitive.

CompanyId

URL , required

Company Id assigned by IBM to identify the caller's company. You can find this value in IBM Sterling Customer Center under My Company > SCI Company ID.

direction

STRING , required

Direction of data relative to the caller's systems. Valid values are 'inbound or 'outbound'.

documentid

STRING , optional

A document identifier that is meaningful to the caller. The identifier is displayed in IBM Supply Chain Shared Ledger as the document code in the Milestone view.

processed

STRING , required

ISO-8601 formatted timestamp indicating when the document was originally processed or generated by the caller's systems.

Request code
								
curl --request POST \ --url 'https://api.ibm.com/scsharedledgers/run/api/input/v1/{CompanyId}/doc?alias=string&direction=string&documentid=string&processed=string' \ --header 'x-ibm-client-id: REPLACE_KEY_VALUE' \ --header 'x-ibm-client-secret: REPLACE_KEY_VALUE'
Response model

200

200 OK. The request completed successfully.

400

400 Validation error.

Body

message

STRING , optional

Message describing the error.

403

403 Unauthorized.

Body

message

STRING , optional

Message describing the error.

Response example

200

200 OK. The request completed successfully.

400

400 Validation error.

								{
  "message" : string
}
							

403

403 Unauthorized.

								{
  "message" : string
}
							

Loading content...

Resources