Boomi API Subscription
Test Setup
Sign In to Boomi Portal at https://api-doc-test.sea.system.tamus.edu/
- Can follow the “First-time instructions” from the landing page
- Will want to Subscribe to “SSO User Account v1” in the API Catalog
- Will receive from SEA Support:
- An X-API-Key to supply as an authentication token
- A System Code to supply as a partner application identification code
Production Setup
Repeat the above steps at https://api-doc.sea.system.tamus.edu/. You will get a new X-API-Key with your Production subscription to the API.
You should re-use your UIN Services’ System Code in your Production API calls.
Client Web API Requests
A POST request to “https://api-test.sea.system.tamus.edu/ws/rest/sso/useraccount/v1/swagger.json” with the given X-API-Key header will produce a service specification, but will not specify the request/response body structures.
Send POST requests to…
- TEST: “https://api-test.sea.system.tamus.edu/ws/rest/sso/useraccount/v1/Affiliate/Upsert”
- PRODUCTION: “https://api.sea.system.tamus.edu/ws/rest/sso/useraccount/v1/Affiliate/Upsert”
…with the proper X-API-Key and Content-Type (text/xml or text/json) headers, and a Request body modeled after the examples below.
Example XML Request / Response:
Request
<AffiliateUpsertRequest> <UIN>123006789</UIN> <EmailAddress>affiliate@tamus.edu</EmailAddress> <SystemCode>SYCD</SystemCode> </AffiliateUpsertRequest>
* Note that “SYCD” represents the UIN Services’ System Code in this example. Your System Code will be different.
Response
<?xml version='1.0' encoding='UTF-8'?> <UpsertAffiliateUserAccountResponse> <RecordCount>2</RecordCount> <ResultMessage>Success</ResultMessage> <ResultCode>SU</ResultCode> </UpsertAffiliateUserAccountResponse>
Example JSON Request / Response:
Request
{
"AffiliateUpsertRequest": {
"UIN": "123006789",
"EmailAddress": "affiliate@tamus.edu",
"SystemCode": "SYCD"
}
}
Response
{
"RecordCount" : 2,
"ResultMessage" : "Success",
"ResultCode" : "SU"
}