GET | /signup/api/integration/partner/{name} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Partner | form | IntegrationPartner | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IntegrationPartnerId | form | int | No | |
Name | form | string | No | |
Description | form | string | No | |
Uri | form | string | No | |
Username | form | string | No | |
Password | form | string | No | |
ApiKey | form | string | No | |
OAuthSettings | form | IntegrationPartnerOAuthSettings | No | |
DetinationConfigurations | form | List<IntegrationDestinationConfig> | No | |
Scope | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
NatId | form | int | No | |
ChapId | form | int | No | |
AuthorizeUrl | form | string | No | |
AuthorizeRedirectUri | form | string | No | |
TokenUrl | form | string | No | |
UserInfoUrl | form | string | No | |
ConsumerKey | form | string | No | |
ConsumerSecret | form | string | No | |
Username | form | string | No | |
Password | form | string | No | |
SecurityToken | form | string | No | |
AppRedirects | form | List<OAuthAppRedirects> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Scope | form | string | No | |
RedirectTemplate | form | string | No | |
AllowAnonymous | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | string | No | |
UriType | form | DestinationUriType | No | |
Uri | form | string | No | |
AuthenticationKey | form | string | No |
Name | Value | |
---|---|---|
None | 0 | |
Absolute | 1 | |
Relative | 2 |
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
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"}}