Hosted setup

Hosted setup

Overview

The hosted setup for your nonprofit discount program enables you to have it set up in no time and with barely any engineering resource.

You will be able to quickly have your branded discount program live and start onboarding nonprofits to your product.

Below you can see a summary of what you can customize:

image

And the process for hosted applications:

image

1: Customize the hosted application form

You can customize the look and feel of the hosted form. To do this you need to provide us:

  • A logo or icon that will be displayed on the form. For best results, we recommend that your logo is a square image larger than 128 x 128 pixels. JPG, JPEG and PNG file types are supported.
  • A CSS hex colour value representing the primary branding colour for the hosted form e.g. #EB3434

2: Implement the hosted application form

It takes ~2h to set up the nonprofit validation hosted setup

Add an endpoint on your server that creates a validation invite. A validation invite is a one off invitation to complete a validation submission. To do this you will need to make a POST request to Percent’s API.

Create a validation invite

POST https://api.poweredbypercent.com/v1/validation-invites
Authentication: Secret Key
Content-Type: application/json

{
	"redirectUrl": "https://example.com/finish",
	"metadata": {
		"key1": "value1",
		"key2": "value2"
	}
}

Configure a validation invite

Validation Invites have the following parameters that you can use for one time validations.

redirectUrl → URL that the hosted form redirects to after the flow is completed.

metadata → an object that you can use to attach key-value data to the Validation Invite.

Example response

You will then be returned a response matching the format of the example below:

{
  "data": {
    "id": "validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "status": "open",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
    "language": "en-GB",
    "redirectUrl": "https://example.com/finish",
    "url": "https://validation.poweredbypercent.com/validate/validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx?token=asasjhd",
    "createdAt": "2020-10-13T17:46:54.000Z",
    "expiresAt": "2020-10-20T17:46:54.000Z"
  },
  "object": "validation_invite"
}

After creating the Validation Invite, redirect your user to the URL for the hosted form returned in the response.

Add-ons to your hosted setup

Add-ons

← Previous

API setup

💠
https://poweredbypercent.com/

Website API reference Blog Give us feedback

Footer Social Icons

© 2022 We Are Percent Ltd.