adding RENXT Lists connector (#1296)
* adding RENXT Lists connector * fix connector name
This commit is contained in:
Ben Lambert
GitHub
Родитель
c9c5215ddc
Коммит
bac89fe776
|
|
@ -0,0 +1,319 @@
|
|||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"version": "1.0",
|
||||
"title": "Blackbaud Raisers Edge NXT Lis",
|
||||
"description": "Blackbaud Raiser's Edge NXT is a comprehensive cloud-based fundraising and donor management software solution built specifically for nonprofits and the entire social good community. Use the Lists connector to manage lists.",
|
||||
"contact": {
|
||||
"name": "Blackbaud Support",
|
||||
"url": "https://www.blackbaud.com/support",
|
||||
"email": "skyapi@blackbaud.com"
|
||||
},
|
||||
"x-ms-api-annotation": {
|
||||
"status": "Preview"
|
||||
}
|
||||
},
|
||||
"x-ms-connector-metadata": [
|
||||
{
|
||||
"propertyName": "Website",
|
||||
"propertyValue": "https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt"
|
||||
},
|
||||
{
|
||||
"propertyName": "Privacy policy",
|
||||
"propertyValue": "https://www.blackbaud.com/privacy-shield"
|
||||
},
|
||||
{
|
||||
"propertyName": "Categories",
|
||||
"propertyValue": "Sales and CRM;Productivity"
|
||||
}
|
||||
],
|
||||
"host": "api.sky.blackbaud.com",
|
||||
"basePath": "/",
|
||||
"schemes": [
|
||||
"https"
|
||||
],
|
||||
"securityDefinitions": {
|
||||
"skyApiOAuth": {
|
||||
"type": "oauth2",
|
||||
"flow": "accessCode",
|
||||
"authorizationUrl": "https://oauth2.sky.blackbaud.com/authorization",
|
||||
"tokenUrl": "https://oauth2.sky.blackbaud.com/token",
|
||||
"scopes": {}
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"skyApiOAuth": []
|
||||
}
|
||||
],
|
||||
"paths": {
|
||||
"/list/v1/appendidstolist": {
|
||||
"post": {
|
||||
"operationId": "AppendIDsToList",
|
||||
"summary": "Add records to a list",
|
||||
"description": "Add a set of records to an existing list.",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "body",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ListApi.AppendIDsToListRequest"
|
||||
},
|
||||
"description": "An object that represents the set of records to append to the list."
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Returned when the operation succeeds."
|
||||
},
|
||||
"400": {
|
||||
"description": "Returned when the specified request parameters are not in the appropriate format."
|
||||
},
|
||||
"403": {
|
||||
"description": "Returned when the user does not have permission to modify lists."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/list/v1/createlistfromids": {
|
||||
"post": {
|
||||
"operationId": "CreateListFromIDs",
|
||||
"summary": "Create a list from a set of records",
|
||||
"description": "Creates a new list filtered to the specified set of records.",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "body",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ListApi.CreateListFromIDsRequest"
|
||||
},
|
||||
"description": "An object that represents the list to create.",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Returned when the operation successfully creates a list. The response body contains the ID of the new list.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ListApi.CreatedList"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Returned when the specified request parameters are not in the appropriate format."
|
||||
},
|
||||
"403": {
|
||||
"description": "Returned when the user does not have permission to create lists."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/list/v1/lists": {
|
||||
"get": {
|
||||
"operationId": "ListLists",
|
||||
"summary": "List lists",
|
||||
"description": "Get a list of lists.",
|
||||
"x-ms-visibility": "internal",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "list_type",
|
||||
"in": "query",
|
||||
"description": "The type of list to return.",
|
||||
"required": true,
|
||||
"type": "string",
|
||||
"x-ms-summary": "List type",
|
||||
"default": "Constituent",
|
||||
"enum": [
|
||||
"Constituent",
|
||||
"Gift",
|
||||
"Action",
|
||||
"Opportunity"
|
||||
]
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Returned when the operation succeeds.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/ListApi.ApiCollectionOfList"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Returned when the specified request parameters are not in the appropriate format."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"ListApi.ApiCollectionOfList": {
|
||||
"type": "object",
|
||||
"description": "Lists",
|
||||
"properties": {
|
||||
"count": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "The total number of lists in the set.",
|
||||
"x-ms-summary": "Count"
|
||||
},
|
||||
"value": {
|
||||
"type": "array",
|
||||
"description": "The set of items included in the response.",
|
||||
"items": {
|
||||
"$ref": "#/definitions/ListApi.ApiList"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListApi.ApiList": {
|
||||
"type": "object",
|
||||
"description": "List",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "The system record ID for the list."
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The name of the list."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListApi.AppendIDsToListRequest": {
|
||||
"type": "object",
|
||||
"description": "Describes the set of records to append to the list.",
|
||||
"required": [
|
||||
"list_type",
|
||||
"list_id",
|
||||
"ids"
|
||||
],
|
||||
"properties": {
|
||||
"list_type": {
|
||||
"type": "string",
|
||||
"description": "The type of list.",
|
||||
"x-ms-summary": "List type",
|
||||
"enum": [
|
||||
"Constituent",
|
||||
"Gift",
|
||||
"Action",
|
||||
"Opportunity"
|
||||
]
|
||||
},
|
||||
"list_id": {
|
||||
"type": "string",
|
||||
"description": "The system record ID of the list.",
|
||||
"x-ms-summary": "List",
|
||||
"x-ms-dynamic-values": {
|
||||
"operationId": "ListLists",
|
||||
"value-collection": "value",
|
||||
"value-path": "id",
|
||||
"value-title": "name",
|
||||
"parameters": {
|
||||
"list_type": {
|
||||
"parameter": "list_type"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-ms-dynamic-list": {
|
||||
"operationId": "ListLists",
|
||||
"itemsPath": "value",
|
||||
"itemValuePath": "id",
|
||||
"itemTitlePath": "name",
|
||||
"parameters": {
|
||||
"list_type": {
|
||||
"parameterReference": "body/list_type"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"ids": {
|
||||
"type": "array",
|
||||
"description": "The unique identifiers for the records to be added to the list (maximumum of 100,000 values).",
|
||||
"x-ms-summary": "ID(s)",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListApi.CreateListFromIDsRequest": {
|
||||
"type": "object",
|
||||
"description": "Describes the list to create with the specified unique record identifiers.",
|
||||
"required": [
|
||||
"name",
|
||||
"description",
|
||||
"list_type",
|
||||
"list_permissions",
|
||||
"ids"
|
||||
],
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"maxLength": 50,
|
||||
"minLength": 0,
|
||||
"description": "The name of the list. Character limit: 50.",
|
||||
"x-ms-summary": "Name"
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"description": "The description of the list.",
|
||||
"x-ms-summary": "Description"
|
||||
},
|
||||
"list_type": {
|
||||
"type": "string",
|
||||
"description": "Determines the type of list to create.",
|
||||
"x-ms-summary": "List type",
|
||||
"enum": [
|
||||
"Constituent",
|
||||
"Gift",
|
||||
"Action",
|
||||
"Opportunity"
|
||||
]
|
||||
},
|
||||
"list_permissions": {
|
||||
"type": "string",
|
||||
"description": "Determines whether other users can access the list.",
|
||||
"x-ms-summary": "Permissions",
|
||||
"enum": [
|
||||
"OnlyOwnerCanAccess",
|
||||
"OthersCanView",
|
||||
"OthersCanViewAndEdit"
|
||||
]
|
||||
},
|
||||
"ids": {
|
||||
"type": "array",
|
||||
"description": "The unique identifiers for the records contained in the list (maximumum of 100,000 values).",
|
||||
"x-ms-summary": "ID(s)",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListApi.CreatedList": {
|
||||
"type": "object",
|
||||
"description": "Created list",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "The ID of the newly created list.",
|
||||
"x-ms-summary": "ID"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
{
|
||||
"properties": {
|
||||
"connectionParameters": {
|
||||
"token": {
|
||||
"type": "oauthSetting",
|
||||
"oAuthSettings": {
|
||||
"identityProvider": "oauth2",
|
||||
"clientId": "PLACEHOLDER_CLIENTID",
|
||||
"scopes": [],
|
||||
"redirectMode": "Global",
|
||||
"redirectUrl": "https://global.consent.azure-apim.net/redirect",
|
||||
"properties": {
|
||||
"IsFirstParty": "False"
|
||||
},
|
||||
"customParameters": {
|
||||
"authorizationUrl": {
|
||||
"value": "https://oauth2.sky.blackbaud.com/authorization"
|
||||
},
|
||||
"tokenUrl": {
|
||||
"value": "https://oauth2.sky.blackbaud.com/token"
|
||||
},
|
||||
"refreshUrl": {
|
||||
"value": "https://oauth2.sky.blackbaud.com/token"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"iconBrandColor": "#71BF43",
|
||||
"capabilities": [],
|
||||
"policyTemplateInstances": [
|
||||
{
|
||||
"templateId": "setheader",
|
||||
"title": "SKY API Subscription Key",
|
||||
"parameters": {
|
||||
"x-ms-apimTemplateParameter.name": "Bb-Api-Subscription-Key",
|
||||
"x-ms-apimTemplateParameter.value": "PLACEHOLDER_API_KEY",
|
||||
"x-ms-apimTemplateParameter.existsAction": "override",
|
||||
"x-ms-apimTemplate-policySection": "Request"
|
||||
}
|
||||
}
|
||||
],
|
||||
"publisher": "Blackbaud, Inc.",
|
||||
"stackOwner": "Blackbaud, Inc."
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
## Blackbaud Raiser's Edge NXT Lists Connector
|
||||
|
||||
[Raiser's Edge NXT](https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt) is a comprehensive cloud-based fundraising and donor management software solution built specifically for nonprofits and the entire social good community.
|
||||
|
||||
This connector is built on top of Blackbaud's [SKY API](https://developer.blackbaud.com/skyapi), and provides operations to help manage lists within The Raiser's Edge NXT.
|
||||
|
||||
## API Documentation
|
||||
https://developer.blackbaud.com/skyapi
|
||||
|
||||
## Pre-requisites
|
||||
To create a custom version of this connector, you will need to:
|
||||
* [Sign in](https://signin.blackbaud.com) (or create) a Blackbaud ID.
|
||||
* [Sign up](https://developer.blackbaud.com/signup) for a developer account using your Blackbaud ID.
|
||||
* Request a [subscription](https://developer.blackbaud.com/subscriptions) to the SKY API to get an API key (will be used in the next steps).
|
||||
* Register an [application](https://developer.blackbaud.com/apps) to get OAuth client ID/secret credentials (will be used in the next steps).
|
||||
|
||||
## Configure the connector properties
|
||||
Using the values obtained in the previous step, update the following placeholder values in the `apiProperties.json` file:
|
||||
* PLACEHOLDER_CLIENTID
|
||||
* PLACEHOLDER_API_KEY
|
||||
|
||||
## Deployment instructions
|
||||
Please use [these instructions](https://docs.microsoft.com/en-us/connectors/custom-connectors/paconn-cli) to deploy this connector as a custom connector within Microsoft Power Automate and Power Apps.
|
||||
|
||||
Don't forget to specify the `--secret <client_secret>` value (obtained in the previous steps) when running the `paconn create` commamnd.
|
||||
|
||||
## Further Support
|
||||
For further support, please visit our developer community at https://community.blackbaud.com/developer
|
||||
Загрузка…
Ссылка в новой задаче