Individual Quote in MPS RESTful API

Design Specification

Payments team/SAP team

VersionChangesDateBy

1Initial draft15th April 2015Vijay

Individual Quote in MPS RESTful APIOverviewThis 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 SAPBroadly speaking, there are three points of interaction points to be considered for this stage of the integration. These are:1. Creating Business Partner information (contact author) in SAP at submission (DEV-5000)1. Update the business partner information1. Creating and updating individual quotes into SAP (DEV-5001)1. Getting quote information back from SAP systemThis 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.

EnvironmentsInboundFive environments will be configured for processing the incoming requests on the BMC side. The base addresses will be:1. Development: api.biomedcentral.com.dev.test (internal)1. QA: api.biomedcentral.com.qa.test (internal)1. User Acceptance Testing: api.biomedcentral.com.uat.test (internal) 1. Pre-production/staging: api.biomedcentral.com.stage.test (internal) 1. Production: api.biomedcentral.comOutboundDetails to be confirmed by MPS team1. Development/testing: senldogomts.springer-sbm.com1. QA: senldogomqs.springer-sbm.com1. Production: senldogomps.springer-sbm.com

Outbound Message DefinitionCreate Business Partner in MPSAPI callURL POST: https://senldogomqs.springer-sbm.com:8020/fmcall/ZBMC_BP_CREATE?format=JSONREQUEST{ "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" : "test@test.com", "phone" : "123-456-5432", "region" : "NY", "language" : "EN", "currency" : "USD", "bpkind" : "0001"}

RESPONSE{ "SALESORG" : "1145", "distributionChannel" : "01", "division" : "01", "bpid" : "3001662660",Comment by Aneraye, Vijay, Crest: Response should give me the Business partner Id "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" : "test@test.com", "phone" : "123-456-5432", "region" : "NY", "language" : "EN", "currency" : "USD", "bpkind" : "0001"}

update Business Partner in MPSAPI callURL POST: https://senldogomqs.springer-sbm.com:8020/fmcall/ZBMC_BP_CREATE?format=JSONREQUEST{ "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" : "test@test.com", "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" : "test@test.com", "phone" : "123-456-5432", "region" : "NY", "language" : "EN", "currency" : "USD", "bpkind" : "0001"}

Create Individual quote in MPSAPI callURL : POST https://senldogomqs.springer-sbm.com:8020/fmcall/Zbmc_inbound?format=JSON Request{ "BMC_INBOUND" : { "amountCharged" : 1657.75,Comment by Aneraye, Vijay, Crest: APC agreed by author at the time of submission "appliedInstitutionalShare" : 1,Comment by Aneraye, Vijay, Crest: OPTIONAl "authorComments" : null, "bpid" : "1600001192",Comment by Aneraye, Vijay, Crest: Authors Business parter id "contractId" : "5302855138",Comment by Aneraye, Vijay, Crest: Optional field. Constract number In case of support or share support, "contactAuthor" : { "address" : null, "authorIdentifiers" : [ ], "bpid" : null, "department" : null, "email" : "marta.romeu@urv.cat", "firstName" : "MARTA", "institution" : null, "institutionIdentifiers" : [ ], "lastName" : "ROMEU", "middleName" : null, "primary" : false, "salutation" : null, "suffix" : null }, "contributingAuthors" : [ { "address" : null, "authorIdentifiers" : [ ], "bpid" : null, "department" : null, "email" : "nuria.aranda@urv.cat", "firstName" : "Nuria", "institution" : null, "institutionIdentifiers" : [ ], "lastName" : "Aranda", "middleName" : null, "primary" : false, "salutation" : null, "suffix" : null }, { "address" : null, "authorIdentifiers" : [ ], "bpid" : null, "department" : null, "email" : "montse.giralt@urv.cat", "firstName" : "Montserrat", "institution" : null, "institutionIdentifiers" : [ ], "lastName" : "Giralt", "middleName" : null, "primary" : false, "salutation" : null, "suffix" : null } ], "currency" : "EUR",Comment by Aneraye, Vijay, Crest: Authors country currency "discountAmount" : 87.25, "discountedAPC" : 1657.75, "doi" : "10.1186/1475-2891-12-102", "exportOrder" : true, "fullAPC" : 1745, "funderInfo" : null, "impactFactor" : "2.64", "institutionId" : "1852",Comment by Aneraye, Vijay, Crest: Optional "institutionName" : "University of Birmingham",Comment by Aneraye, Vijay, Crest: Optional "itemNumber" : "000010",Comment by Aneraye, Vijay, Crest: OPTIONAL field "itemReferenceNumber" : "000010",Comment by Aneraye, Vijay, Crest: Optional field "journalId" : "12937", "journalName" : "Nutrition Journal", "manuscriptId" : "2265769316481744", "manuscriptTitle" : "Diet, iron biomarkers and oxidative stress in a representative sample of Mediterranean population", "orderType" : "1",Comment by Aneraye, Vijay, Crest: Need to discuss with Bill ? "publicationDate" : "", "publisherName" : "Biomed Central", "submissionDate" : "20130228", "submittingAuthor" : { "address" : null, "authorIdentifiers" : [ ], "bpid" : null, "department" : "Unitat de Nutrici i Salut Pblica", "email" : "victoria.arija@urv.cat", "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/INVOICEComment by Aneraye, Vijay, Crest: Optional : In case of individual quote, default value should be CREDITCARD } }

Inbound Message DefinitionGetting individual quote information Back from MPSURL : GET https://senldogomqs.springer-sbm.com:8020/fmcall/ZGETAPI4?format=JSON&MANUSCRIPTIDFROM={manuscriptId}&MANUSCRIPTIDTO={manuscriptId}&BPID={BPID} RESPONSE:

{ "BMC_INBOUND: { sapOrderId:323211Comment by Aneraye, Vijay, Crest: Response should give me the order id back "amountCharged" : 1657.75, "appliedInstitutionalShare" : 1, "authorComments" : null, "bpid" : "1600001192", "contractId" : "5302855138", "contactAuthor" : { "address" : null, "authorIdentifiers" : [ ], "bpid" : null, "department" : null, "email" : "marta.romeu@urv.cat", "firstName" : "MARTA", "institution" : null, "institutionIdentifiers" : [ ], "lastName" : "ROMEU", "middleName" : null, "primary" : false, "salutation" : null, "suffix" : null }, "contributingAuthors" : [ { "address" : null, "authorIdentifiers" : [ ], "bpid" : null, "department" : null, "email" : "nuria.aranda@urv.cat", "firstName" : "Nuria", "institution" : null, "institutionIdentifiers" : [ ], "lastName" : "Aranda", "middleName" : null, "primary" : false, "salutation" : null, "suffix" : null }, { "address" : null, "authorIdentifiers" : [ ], "bpid" : null, "department" : null, "email" : "montse.giralt@urv.cat", "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" : "victoria.arija@urv.cat", "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,Comment by Aneraye, Vijay, Crest: This field should give the VAT amout author has to pay. "adminFee" : 55Comment by Aneraye, Vijay, Crest: When paymentMethod=INVOICE "paymentMethod" : CREDITCARD/INVOICE } }