API reference · Authentication

Create a donor platform widget token

POST/v1/authentication/donor-platform/widget

Generate a JWT access token to be used to render donor platform widgets in your product. ⚠️ This endpoint is rate limited, it should only be called on previous token expiration which should be once a day.

Requires a Bearer access token.

Body

CreateDonorWidgetTokenDto

This field has no description in the spec.

donorId#stringrequiredUUID

Response

200 · TokenResponse

This field has no description in the spec.

accessToken#stringalways returned

Errors

400A field is missing, has the wrong type, or is not part of the request schema.

Every request with a body or query is validated.

{
  "statusCode": 400,
  "message": [
    "amount must not be less than 1",
    "property foo should not exist"
  ],
  "error": "Bad Request"
}

401Unauthorized
Missing, expired or invalid access token.
```
{
  "statusCode": 401,
  "message": "Unauthorized"
}
```

402Plan upgrade required

{
  "statusCode": 402,
  "message": "Plan upgrade required"
}

403Account closed

{
  "message": "Account closed",
  "code": "ACCOUNT_CLOSED"
}

403Forbidden
Your credentials cannot perform this action on this resource. An id from another account answers 404 in the path, 400 in the body or the query.
```
{
  "statusCode": 403,
  "message": "Forbidden"
}
```
404Not Found
No resource with this id on your account: the API answers as if it did not exist.
```
{
  "statusCode": 404,
  "message": "Not Found"
}
```

POST /v1/authentication/donor-platform/widget

1curl -X POST https://api.sandbox.charitips.com/v1/authentication/donor-platform/widget \2  -H "Authorization: Bearer $CHARITIPS_TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5    "donorId": "<donorId>"6  }'

Built from the spec and the API code

Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.