everydayhero: Developer

Registered Applications

Registered Applications are not the optimum method of authenticating with the API. All API endpoints are now available via OAuth and can be self-served via Authentication.

Authentication types: OAuth (Internal) Application Token

Listing Registered Applications

GET /api/v2/internal/registered_applications?registered_application[campaign_uid]=CAMPAIGN_UID
Authorization: Bearer APP_BEARER_TOKEN
Content-Type: application/json

Creating a registered application

POST /api/v2/internal/registered_applications
Authorization: Bearer APP_BEARER_TOKEN
Content-Type: application/json

{"registered_application":{"name":"test","campaign_uid":"au-123"}}

Available params:

campaign_uid : required string
UID of the campaign

individual_registration_url : optional string
Registration redirect for individual pages (when a user accesses get-started)

team_registration_url : optional string
Registration redirect for individual pages joining teams (when a user accesses join team)

name : required string
Name of the application

trusted : optional boolean
Trusted or not, default false. This removes the permissions consent screen on connection if set to true.

Example curl request

curl -X POST -H "Authorization: Bearer xxx" -H "Content-Type: application/json" -d '{"registered_application":{"campaign_uid":"xxx","name":"test"}}' "http://everydayhero.com/api/v2/internal/registered_applications"

Updating a registered application

PATCH /api/v2/internal/registered_applications/APPLICATION_UID
Authorization: Bearer APP_BEARER_TOKEN
Content-Type: application/json

{"registered_application":{"name":"test"}}

Available params:

individual_registration_url : optional string
Registration redirect for individual pages (when a user accesses get-started)

team_registration_url : optional string
Registration redirect for individual pages joining teams (when a user accesses join team)

name : string
Name of the application

trusted : optional boolean
Trusted or not, default false. This removes the permissions consent screen on connection if set to true.

Example curl request

curl -X PATCH -H "Authorization: Bearer xxx" -H "Content-Type: application/json" -d '{"registered_application":{"name":"test2"}}' "http://everydayhero.com/api/v2/internal/registered_applications/APPLICATION_UID"

Viewing a registered application

GET /api/v2/internal/registered_applications/APPLICATION_UID?access_token=ACCESS_TOKEN

Deleting a registered application

DELETE /api/v2/internal/registered_applications/APPLICATION_UID
Authorization: Bearer APP_BEARER_TOKEN
Content-Type: application/json