Riseact - API & Developer Guide
Integrarsi con Riseact
Riseact offre 2 modi per integrarsi con la piattaforma: tramite applicazioni private o applicazio...
Area partner
Cos'è l'Area partner
L'Area partner è per chi sviluppa e distribuisce soluzioni per le organizzazioni su Riseact, o ne...
Organizzazioni amministrate
Le organizzazioni amministrate sono quelle che il tuo profilo partner gestisce per conto dei clie...
Organizzazioni di sviluppo
Un'organizzazione di sviluppo serve a costruire e provare applicazioni e temi senza dati né pagam...
Distribuire applicazioni
Dalla sezione Applicazioni dell'Area partner crei e distribuisci applicazioni integrate con Risea...
Temi
Un tema è l'aspetto del sito di un'organizzazione. Come partner lo crei, ne pubblichi le versioni...
Applicazioni private
Applicazioni private
Un'applicazione privata accede alle API di Riseact con un token statico, senza flusso OAuth. È pe...
Utilizzo delle API
Riseact espone API GraphQL e REST, con lo stesso token.GraphQLEndpoint: POST https://core.riseact...
Webhook di Organizzazione
Riseact chiama il tuo endpoint quando in un'organizzazione succede qualcosa: un sostenitore creat...
Applicazioni partner
Iniziare
Per pubblicare applicazioni e temi per le organizzazioni su Riseact serve un account partner: seg...
Utilizzo delle APIs
Riseact espone API GraphQL e REST. In entrambi i casi l'access token va nell'header di autorizzaz...
Creare un'applicazione partner
Per usare le API di Riseact serve un'applicazione.Accedi al tuo account Riseact Partner.Dal menu ...
Autenticazione con OAuth
Per chiamare le API serve un access token, che l'applicazione ottiene con il flusso OAuth authori...
Interfaccia utente dell'applicazione
Riseact mostra l'applicazione in un iframe nel portale di amministrazione, caricando l'URL indica...
Webhook di Applicazione
I webhook di applicazione sono chiamate HTTP che Riseact invia al tuo endpoint quando avvengono c...
Pubblicazione
Per rendere l'applicazione disponibile a tutte le organizzazioni la pubblichi sullo store di Rise...
Concetti di base
Entità di Riseact
Riseact dispone di diverse entità che consentono di gestire le iniziative di raccolta fondi delle...
Donazioni e pagamenti
Su Riseact esistono 2 entità per la gestione delle donazioni: donation e payment. Ogni pagamento ...
Configurazione campagna e checkouts
Riseact offre funzionalità avanzate per la gestione dei checkouts, semplificando il processo di f...
Campagne, progetti e checkout
CampagneLe campagne sono entità che rappresentano iniziative specifiche. Ogni campagna include la...
Canali di pubblicazione
I canali di pubblicazione sono le piattaforme su cui è possibile pubblicare le campagne. Ogni cam...
Custom Field
I custom field consentono alle organizzazioni di estendere le entità di Riseact con campi persona...
Metodi di pagamento
I metodi di pagamento ( PaymentMethod) definiscono come un'organizzazione può ricevere denaro. Og...
Temi
Motore dei temi
Il sito dell'organizzazione è reso con template Jinja2. Sintassi di base:{{ variabile }} ...
Creare e sviluppare un tema
Un tema è una cartella di file di testo (template, sezioni, snippet, CSS) che Riseact pubblica in...
Variabili di contesto
Contesto globaleDisponibile in ogni template (layout, sezioni, pagine).VariabileTipoNotecurrent_u...
Oggetti e attributi
Attributi degli oggetti passati ai template.organizationCampoDescrizionenamenome dell'organizzazi...
Campi personalizzati
I custom field della campagna sono esposti in campaign.customfields.{{ campaign.customfields['chi...
Tag e filtri
Tag personalizzatiTagUso{% schema %}{ ...JSON... }{% endschema %}definisce lo schema della sezion...
Sezioni e impostazioni del tema
Oltre al contesto globale, le sezioni ricevono:VariabileContenutothemedict con le impostazioni gl...
Checkout
Checkout
Il checkout Riseact è il form di donazione: importo, anagrafica, pagamento. Puoi usare quello di ...
Donation Button
Il Donation Button è uno script da incorporare nel tuo sito: apre il checkout in una modale sulla...
Prefilling del checkout
Puoi precompilare il checkout con parametri nella query string dell'URL della campagna: anagrafic...
Crea il tuo checkout personalizzato
Il tuo frontend raccoglie i dati, il tuo backend li invia alle API autenticate di Riseact, che re...
Donation Box
Introduzione a Donation Box
Donation BoxDonation Box è lo stand di Riseact per la raccolta fondi in presenza: un tablet Andro...
Configurazione
Come configurare una Donation Box: tablet Android con Riseact Kiosk e terminale WisePOS E.Tablet ...
Personalizzazione
Il form di donazione di Riseact Kiosk si personalizza da Riseact Admin.CampagneDi default Riseact...
CLI e SDK
Panoramica
La CLI di Riseact serve a creare, sviluppare e pubblicare applicazioni e temi per Riseact:crea un...
Struttura dell'app
Il template Node delle applicazioni Riseact è un punto di partenza: puoi adattarlo al tuo progett...
Tunnel di sviluppo
Riseact carica la tua applicazione in un iframe del pannello, ma i suoi server non raggiungono il...
API
Utilizzo delle API REST
Le API REST sono disponibili per ogni applicazione creata su Riseact e richiedono un Access Token...
Utilizzo delle API GraphQL
Le API GraphQL sono disponibili per ogni applicazione creata su Riseact e richiedono un Access To...
Esplora il grafo GraphQL
Con Apollo Sandbox esplori lo schema GraphQL di Riseact: tipi e campi, composizione di query e mu...
Paginazione GraphQL
Le liste GraphQL sono paginate a cursore: inserimenti e cancellazioni durante la navigazione non ...
Paginazione REST
Le liste REST sono paginate per offset, con i parametri limit e offset.ParametriParametroTipoDefa...
Gestione degli errori GraphQL
Due tipi di erroreTipoDove appareQuando si usauserErrorsNel payload della mutationErrori di valid...
Importazioni
Importazioni CSV
Riseact importa sostenitori e donazioni da file CSV. Gli importatori servono a caricare i dati in...
Importazione sostenitori
Formato del file, valori e deduplica sono descritti in Importazioni CSV.Nessuna colonna è obbliga...
Importazione donazioni
Ogni riga contiene sostenitore, donazione e pagamento. Formato del file, valori e deduplica sono ...
Esportazioni
Esportazioni
Riseact esporta sostenitori, donazioni e pagamenti in CSV o Excel: una tabella piatta dei record ...
Esportazione sostenitori
Una riga per sostenitore: anagrafica e statistiche sulle donazioni. La prima colonna è sempre id....
Esportazione donazioni
Una riga per donazione, con sostenitore, campagna, metodo di pagamento e identificativi della tra...
Esportazione pagamenti
Una riga per pagamento, quindi una per ogni rata delle donazioni ricorrenti, con donazione, soste...
Script di post-elaborazione
Un'esportazione CSV può passare da uno script Python scritto da te prima di diventare il file da ...
GraphQL API References
Queries
activitiesType: ActivityConnection!Paginated list of the activities of the organization.Arguments...
Mutations
activityCreate Type: ActivityResponse! Creates a task on a supporter or a donation. Arguments Nam...
Objects
AccessToken The access token of a private application, to be sent as a bearer token when calling ...
Enums
ActivityCategory Kind of task recorded on a supporter or a donation, such as a call to make or an...
Input objects
ActivityCreateInput A task to create on a supporter or a donation. Arguments Name Description sub...
Scalars
BooleanThe Boolean scalar type represents true or false.DateDate (isoformat)DateTimeDate with tim...
Rest API references
RiseAct Admin API
Version: 1.0.0AuthenticationHTTP: Bearer AuthSecurity Scheme Type:httpHTTP Authorization Scheme:b...
Activity Create Api
Metodo HTTP: POST Activity Create Api Activity Create Apiapplication/json Request Body required c...
Campaigns Get
Metodo HTTP: GET Campaigns Get Campaigns Get Path Parameters campaign_id Campaign Id requiredResp...
Campaigns List
Metodo HTTP: GET Campaigns List Campaigns List Query Parameters q Q limit Limit Possible values: ...
Checkout Create
Metodo HTTP: POST Checkout Create Checkout Createapplication/json Request Body required campaign_...
Checkouts Get
Metodo HTTP: GET Checkouts Get Checkouts Get Path Parameters checkout_id Checkout Id requiredResp...
Checkouts List
Metodo HTTP: GET Checkouts List Checkouts List Query Parameters q Q order Order state CheckoutSta...
Donations Get
Metodo HTTP: GET Donations Get Donations Get Path Parameters donation_id Donation Id requiredResp...
Donations List
Metodo HTTP: GET Donations List Donations List Query Parameters q Q archived Archived order Order...
Webhooks Create
Metodo HTTP: POSTWebhooks CreateWebhooks Createapplication/jsonRequest Body requiredtopics Webhoo...
Webhooks Delete
Metodo HTTP: DELETEWebhooks DeleteWebhooks DeletePath Parameterswebhook_id Webhook Id requiredRes...
Webhooks Get
Metodo HTTP: GETWebhooks GetWebhooks GetPath Parameterswebhook_id Webhook Id requiredResponses200...
Webhooks List
Metodo HTTP: GETWebhooks ListWebhooks ListResponses200OKapplication/jsonSchemaExample (from schem...
Webhooks Update
Metodo HTTP: PUTWebhooks UpdateWebhooks UpdatePath Parameterswebhook_id Webhook Id requiredapplic...
Payments Get
Metodo HTTP: GET Payments Get Payments Get Path Parameters payment_id Payment Id requiredResponse...
Payments List
Metodo HTTP: GET Payments List Payments List Query Parameters q Q order Order state PaymentState[...
Supporter Lead Create
Metodo HTTP: POST Supporter Lead Create Supporter Lead Createapplication/json Request Body requir...
Supporters Create
Metodo HTTP: POST Supporters Create Supporters Createapplication/json Request Body required image...
Supporters Delete
Metodo HTTP: DELETE Supporters Delete Supporters Delete Path Parameters supporter_id Supporter Id...
Supporters Get
Metodo HTTP: GET Supporters Get Supporters Get Path Parameters supporter_id Supporter Id required...
Supporters List
Metodo HTTP: GET Supporters List Supporters List Query Parameters q Q order Order type SupporterT...
Supporters Update
Metodo HTTP: PUT Supporters Update Supporters Update Path Parameters supporter_id Supporter Id re...