Scribd
Upload
133 views10 pages

Individual Quote in MPS RESTful API

This document describes the API for integrating an open access payment engine with an MPS system to allow exchange of author information and charging authors in SAP. There are three main interaction points: 1) Creating author business partner profiles in SAP during submission, 2) Updating business partner profiles, and 3) Creating and updating individual author quotes in SAP. The API consists of inbound and outbound messages to support these interactions between the two systems. Environments and addresses for the inbound and outbound messages are defined. Sample request and response JSON formats are provided for creating/updating business partners and individual quotes in the MPS system.

Uploaded by

Mayank Trivedi
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
133 views10 pages

Individual Quote in MPS RESTful API

This document describes the API for integrating an open access payment engine with an MPS system to allow exchange of author information and charging authors in SAP. There are three main interaction points: 1) Creating author business partner profiles in SAP during submission, 2) Updating business partner profiles, and 3) Creating and updating individual author quotes in SAP. The API consists of inbound and outbound messages to support these interactions between the two systems. Environments and addresses for the inbound and outbound messages are defined. Sample request and response JSON formats are provided for creating/updating business partners and individual quotes in the MPS system.

Uploaded by

Mayank Trivedi
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 10

Individual Quote in

MPS RESTful API


Design Specification
Payments team/SAP team

Versi
on

Changes

Date

By

Initial draft

15th April
2015

Vijay

Individual Quote in MPS RESTful API


Overview
This document describes the API for the integration of the BMC open access
payment engine with MPS to allow exchange of individual authors information and
to charge the individual into SAP
Broadly speaking, there are three points of interaction points to be considered for
this stage of the integration. These are:
1
2
3
4

Creating Business Partner information (contact author) in SAP at submission


(DEV-5000)
Update the business partner information
Creating and updating individual quotes into SAP (DEV-5001)
Getting quote information back from SAP system

This API consists of a set of inbound (to BMC) and outbound (from BMC) messages
for the above three interaction points, and these are described in detail below.

Environments
Inbound
Five environments will be configured for processing the incoming requests on the
BMC side. The base addresses will be:
1
2
3
4
5

Development: api.biomedcentral.com.dev.test (internal)


QA: api.biomedcentral.com.qa.test (internal)
User Acceptance Testing: api.biomedcentral.com.uat.test (internal)
Pre-production/staging: api.biomedcentral.com.stage.test (internal)
Production: api.biomedcentral.com

Outbound
Details to be confirmed by MPS team
1
2
3

Development/testing: senldogomts.springer-sbm.com
QA: senldogomqs.springer-sbm.com
Production: senldogomps.springer-sbm.com

Outbound Message Definition


Create Business Partner in MPS
API call
URL POST: https://senldogomqs.springer-sbm.com:8020/fmcall/ZBMC_BP_CREATE?
format=JSON
REQUEST
{

"SALESORG" : "1145",
"distributionChannel" : "01",
"division" : "01",
"bptype" : "0006",
"grouping" : "GP01",
"secondLevel" : "IA",
"lastName" : "Test_API_REST_2",
"middleName" : "R",
"firstName" : "Test",
"street" : "Spring Street",
"houseno" : "123",
"city" : "New York",
"postalcode" : "10013",
"country" : "US",
"email" : "[email protected]",
"phone" : "123-456-5432",
"region" : "NY",
"language" : "EN",
"currency" : "USD",
"bpkind" : "0001"

RESPONSE
{
"SALESORG" : "1145",
"distributionChannel" : "01",
"division" : "01",
"bpid" : "3001662660",
"bptype" : "1",
"grouping" : "GP01",
"secondLevel" : "IA",
"lastName" : "Test_API_REST_2",
"middleName" : "R",
"firstName" : "Test",
"street" : "Spring Street",
"houseno" : "123",
"city" : "New York",
"postalcode" : "10013",
"country" : "US",
"email" : "[email protected]",
"phone" : "123-456-5432",

"region" :
"language"
"currency"
"bpkind" :

"NY",
: "EN",
: "USD",
"0001"

update Business Partner in MPS


API call
URL POST: https://senldogomqs.springer-sbm.com:8020/fmcall/ZBMC_BP_CREATE?
format=JSON
REQUEST
{

"SALESORG" : "1145",
"distributionChannel" : "01",
"division" : "01",
"bptype" : "1",
"bpid" : "3001662660",
"grouping" : "GP01",
"secondLevel" : "IA",
"lastName" : "Test_API_REST_2",
"middleName" : "R",
"firstName" : "Test",
"street" : "Spring Street",
"houseno" : "123",
"city" : "New York",
"postalcode" : "10013",
"country" : "US",
"email" : "[email protected]",
"phone" : "123-456-5432",
"region" : "NY",
"language" : "EN",
"currency" : "USD",
"bpkind" : "0001"

RESPONSE
{
"SALESORG" : "1145",
"distributionChannel" : "01",
"division" : "01",
"bpid" : "3001662660",
"bptype" : "1",
"grouping" : "GP01",
"secondLevel" : "IA",
"lastName" : "Test_API_REST_2",
"middleName" : "R",
"firstName" : "Test",
"street" : "Spring Street",
"houseno" : "123",

"city" : "New York",


"postalcode" : "10013",
"country" : "US",
"email" : "[email protected]",
"phone" : "123-456-5432",
"region" : "NY",
"language" : "EN",
"currency" : "USD",
"bpkind" : "0001"

Create Individual quote in MPS


API call
URL : POST https://senldogomqs.springersbm.com:8020/fmcall/Zbmc_inbound?format=JSON
Request
{
"BMC_INBOUND" : {
"amountCharged" : 1657.75,
"appliedInstitutionalShare" : 1,
"authorComments" : null,
"bpid" : "1600001192",
"contractId" : "5302855138",
"contactAuthor" : {
"address" : null,
"authorIdentifiers" : [ ],
"bpid" : null,
"department" : null,
"email" : "[email protected]",
"firstName" : "MARTA",
"institution" : null,
"institutionIdentifiers" : [ ],
"lastName" : "ROMEU",
"middleName" : null,
"primary" : false,
"salutation" : null,
"suffix" : null
},
"contributingAuthors" : [
{
"address" : null,
"authorIdentifiers" : [ ],
"bpid" : null,
"department" : null,
"email" : "[email protected]",
"firstName" : "Nuria",
"institution" : null,
"institutionIdentifiers" : [ ],
"lastName" : "Aranda",
"middleName" : null,

"primary" : false,
"salutation" : null,
"suffix" : null

},
{ "address" : null,
"authorIdentifiers" : [ ],
"bpid" : null,
"department" : null,
"email" : "[email protected]",
"firstName" : "Montserrat",
"institution" : null,
"institutionIdentifiers" : [ ],
"lastName" : "Giralt",
"middleName" : null,
"primary" : false,
"salutation" : null,
"suffix" : null
}
],
"currency" : "EUR",
"discountAmount" : 87.25,
"discountedAPC" : 1657.75,
"doi" : "10.1186/1475-2891-12-102",
"exportOrder" : true,
"fullAPC" : 1745,
"funderInfo" : null,
"impactFactor" : "2.64",
"institutionId" : "1852",
"institutionName" : "University of Birmingham",
"itemNumber" : "000010",
"itemReferenceNumber" : "000010",
"journalId" : "12937",
"journalName" : "Nutrition Journal",
"manuscriptId" : "2265769316481744",
"manuscriptTitle" : "Diet, iron biomarkers and oxidative stress
in a representative sample of Mediterranean population",
"orderType" : "1",
"publicationDate" : "",
"publisherName" : "Biomed Central",
"submissionDate" : "20130228",
"submittingAuthor" : { "address" : null,
"authorIdentifiers" : [ ],
"bpid" : null,
"department" : "Unitat de Nutrici i Salut Pblica",
"email" : "[email protected]",
"firstName" : "Victoria",
"institution" : null,
"institutionIdentifiers" : [ ],
"lastName" : "Arija",
"middleName" : null,
"primary" : false,
"salutation" : null,
"suffix" : null
},
"url" : "http://www.nutritionj.com/content/12/1/102",
"reason" : "Q01",
"paymentMethod" : CREDITCARD/INVOICE

Inbound Message Definition


Getting individual quote information Back from MPS
URL : GET https://senldogomqs.springer-sbm.com:8020/fmcall/ZGETAPI4?
format=JSON&MANUSCRIPTIDFROM={manuscriptId}&MANUSCRIPTIDTO={manuscri
ptId}&BPID={BPID}
RESPONSE:
{
"BMC_INBOUND: {
sapOrderId:323211
"amountCharged" : 1657.75,
"appliedInstitutionalShare" : 1,
"authorComments" : null,
"bpid" : "1600001192",
"contractId" : "5302855138",
"contactAuthor" : {
"address" : null,
"authorIdentifiers" : [ ],
"bpid" : null,
"department" : null,
"email" : "[email protected]",
"firstName" : "MARTA",
"institution" : null,
"institutionIdentifiers" : [ ],
"lastName" : "ROMEU",
"middleName" : null,
"primary" : false,
"salutation" : null,
"suffix" : null
},
"contributingAuthors" : [
{
"address" : null,
"authorIdentifiers" : [ ],
"bpid" : null,
"department" : null,
"email" : "[email protected]",
"firstName" : "Nuria",
"institution" : null,
"institutionIdentifiers" : [ ],
"lastName" : "Aranda",
"middleName" : null,
"primary" : false,
"salutation" : null,
"suffix" : null
},
{ "address" : null,
"authorIdentifiers" : [ ],
"bpid" : null,
"department" : null,
"email" : "[email protected]",
"firstName" : "Montserrat",

"institution" : null,
"institutionIdentifiers" : [
"lastName" : "Giralt",
"middleName" : null,
"primary" : false,
"salutation" : null,
"suffix" : null

}
}

],

}
],
"currency" : "EUR",
"discountAmount" : 87.25,
"discountedAPC" : 1657.75,
"doi" : "10.1186/1475-2891-12-102",
"exportOrder" : true,
"fullAPC" : 1745,
"funderInfo" : null,
"impactFactor" : "2.64",
"institutionId" : "1852",
"institutionName" : "University of Birmingham",
"itemNumber" : "000010",
"itemReferenceNumber" : "000010",
"journalId" : "12937",
"journalName" : "Nutrition Journal",
"manuscriptId" : "2265769316481744",
"manuscriptTitle" : "Diet, iron biomarkers and oxidative stress
in a representative sample of Mediterranean population",
"orderType" : "1",
"publicationDate" : "",
"publisherName" : "Biomed Central",
"submissionDate" : "20130228",
"submittingAuthor" : { "address" : null,
"authorIdentifiers" : [ ],
"bpid" : null,
"department" : "Unitat de Nutrici i Salut Pblica",
"email" : "[email protected]",
"firstName" : "Victoria",
"institution" : null,
"institutionIdentifiers" : [ ],
"lastName" : "Arija",
"middleName" : null,
"primary" : false,
"salutation" : null,
"suffix" : null
},
"url" : "http://www.nutritionj.com/content/12/1/102",
"reason": "Q01",
"vat" : 0,
"adminFee" : 55
"paymentMethod" : CREDITCARD/INVOICE

You might also like