Billhighway Cloud API

<back to all web services

IntegrationPartnerGetRq

The following routes are available for this service:
GET/signup/api/integration/partner/{name}
IntegrationPartnerGetRq Parameters:
NameParameterData TypeRequiredDescription
NamepathstringNo
IntegrationPartnerRs Parameters:
NameParameterData TypeRequiredDescription
PartnerformIntegrationPartnerNo
IntegrationPartner Parameters:
NameParameterData TypeRequiredDescription
IntegrationPartnerIdformintNo
NameformstringNo
DescriptionformstringNo
UriformstringNo
UsernameformstringNo
PasswordformstringNo
ApiKeyformstringNo
OAuthSettingsformIntegrationPartnerOAuthSettingsNo
DetinationConfigurationsformList<IntegrationDestinationConfig>No
ScopeformstringNo
IntegrationPartnerOAuthSettings Parameters:
NameParameterData TypeRequiredDescription
NatIdformintNo
ChapIdformintNo
AuthorizeUrlformstringNo
AuthorizeRedirectUriformstringNo
TokenUrlformstringNo
UserInfoUrlformstringNo
ConsumerKeyformstringNo
ConsumerSecretformstringNo
UsernameformstringNo
PasswordformstringNo
SecurityTokenformstringNo
AppRedirectsformList<OAuthAppRedirects>No
OAuthAppRedirects Parameters:
NameParameterData TypeRequiredDescription
ScopeformstringNo
RedirectTemplateformstringNo
AllowAnonymousformboolNo
IntegrationDestinationConfig Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
UriTypeformDestinationUriTypeNo
UriformstringNo
AuthenticationKeyformstringNo
DestinationUriType Enum:
NameValue
None0
Absolute1
Relative2

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /signup/api/integration/partner/{name} HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Partner":{"IntegrationPartnerId":0,"Name":"String","Description":"String","Uri":"String","Username":"String","Password":"String","ApiKey":"String","OAuthSettings":{"NatId":0,"ChapId":0,"AuthorizeUrl":"String","AuthorizeRedirectUri":"String","TokenUrl":"String","UserInfoUrl":"String","ConsumerKey":"String","ConsumerSecret":"String","Username":"String","Password":"String","SecurityToken":"String","AppRedirects":[{"Scope":"String","RedirectTemplate":"String","AllowAnonymous":false}]},"DetinationConfigurations":[{"Type":"String","UriType":0,"Uri":"String","AuthenticationKey":"String"}],"Scope":"String"}}