La Poll API v3 continua a funzionare
Il codice scritto per la precedente API di StrawPoll continua a funzionare. Gli endpoint v3 sono
serviti senza modifiche su https://api.strawpoll.com/v3 (e https://strawpoll.com/api/v3),
accettano la stessa intestazione X-API-Key e usano lo stesso JSON, come descritto nella specifica OpenAPI v3.
Per i nuovi progetti usa la Forms API (v4): copre tutti i tipi di domanda, oltre a bozze, risposte e inviti. La v3 riceverà correzioni, ma nessuna nuova funzionalità.
Cosa diventa oggi un sondaggio v3
Ogni sondaggio v3 è un modulo con una sola domanda:
type v3 | Sezione del modulo |
|---|---|
multiple_choice con opzioni text | multiple_choice |
multiple_choice con opzioni image | picture_choice |
ranked_choice | ranked_choice |
meeting con opzioni date e time_range | meeting |
L’id del sondaggio è lo slug del modulo e gli id delle opzioni sono id dei choices, quindi puoi
combinare le due API: crea un sondaggio con la v3 e leggi le sue risposte con la v4, o viceversa. require_voter_names aggiunge una sezione di contatto che chiede un nome.
I moduli con più di una domanda si possono leggere con la v3, che mostra la loro prima domanda.
Le modifiche tramite la v3 vengono rifiutate con 409 unsupported_form, così la v3 non elimina
mai domande che non vede; per questi moduli usa la v4.
Impostazioni
poll_config | Impostazione del modulo |
|---|---|
deadline_at | closesAt |
duplication_checking: ip, session, invite, none | responseDuplicateCheck: ip, session, code, none |
results_visibility: always, after_vote, after_deadline, never | resultsVisibility: public, public_after_response, public_after_close, private |
edit_vote_permissions: admin, admin_voter, voter, nobody | editResponsePermissions: admin, admin_own_responses, own_responses, nobody |
hide_participants | responsesVisibility: private |
allow_comments | allowComments, con commenti pubblici |
allow_vpn_users | l’opposto di blockVPNUsers |
force_appearance: light, dark, auto | il tema chiaro o scuro di StrawPoll, oppure nessuno |
is_multiple_choice, multiple_choice_min, multiple_choice_max | gli stessi, dove 0 significa nessun limite |
allow_other_option | risposte libere |
randomize_options | opzioni in ordine casuale |
allow_indeterminate | risposte «se necessario» nei sondaggi per riunioni |
require_voter_names | una domanda sul nome; sempre attiva nei sondaggi per riunioni |
PUT/polls/{id} mantiene ogni impostazione che ometti da poll_config, e mantiene i voti delle
opzioni di cui rinvii l’id.
I moduli configurati nell’editor possono usare controlli per cui la v3 non ha un valore. Vengono
letti come il valore v3 più vicino: un controllo per nome come session, un controllo per email
come invite.
Differenze da conoscere
- I sondaggi vengono pubblicati subito. La v3 non aveva bozze. Le modifiche con
PUTsono online immediatamente; una bozza aperta nell’editor non viene toccata. is_privateè sempretrue. Sulla nuova piattaforma i sondaggi non vengono mai elencati pubblicamente.- Risultati.
poll_votesvale1(scelta o sì),0(non scelta o no),2(se necessario) enull(nessuna risposta). Perranked_choiceè la posizione che il partecipante ha dato all’opzione, dove1è la prima.poll_participantsè vuoto, a meno che i nomi siano pubblici o il sondaggio sia tuo. I risultati che non puoi ancora vedere rispondono403 results_hidden. - Le risposte libere compaiono come opzioni aggiuntive con
is_write_in: true. - I commenti sono note che i partecipanti lasciano con il loro voto. Puoi elencarli, leggerli
e (se il sondaggio è tuo) eliminarli;
POST/commentsePUT/comments/{id}rispondono501. - Utenti. Non ci sono profili pubblici:
/users/@me(o il tuo id) funziona, qualsiasi altro utente restituisce404.usernameènulleuser_metacontiene solo valori predefiniti.PATCH/users/@memodificadisplayname. - Media.
POST/uploadaccetta immagini (JPEG, PNG, GIF o WebP, fino a 5 MB). Video e media di YouTube e Giphy non sono supportati, quindiPOST/mediaePUT/media/{id}rispondono501.DELETE/media/{id}rifiuta le immagini ancora mostrate in un sondaggio. - I contatori che non esistono più, come
view_counte i punti, valgono0. - Gli errori sono oggetti JSON con
errorecode, e valgono gli stessi limiti di frequenza della v4.
Le tue chiavi esistenti
Le chiavi della piattaforma precedente continuano a funzionare una volta trasferito il tuo account. Puoi anche creare nuove chiavi in Impostazioni → Chiavi API; funzionano sia per la v3 sia per la v4.