A Poll API v3 continua funcionando
O código escrito para a API anterior do StrawPoll continua funcionando. Os endpoints v3 continuam
sendo servidos da mesma forma em https://api.strawpoll.com/v3 (e https://strawpoll.com/api/v3),
aceitam o mesmo cabeçalho X-API-Key e falam o mesmo JSON, como descrito na especificação OpenAPI v3.
Para projetos novos, use a Forms API (v4): ela cobre todos os tipos de pergunta, além de rascunhos, respostas e convites. A v3 continuará recebendo correções, mas não recursos novos.
No que uma enquete v3 se transformou
Cada enquete v3 é um formulário de uma única pergunta:
type v3 | Seção do formulário |
|---|---|
multiple_choice com opções text | multiple_choice |
multiple_choice com opções image | picture_choice |
ranked_choice | ranked_choice |
meeting com opções date e time_range | meeting |
O id de uma enquete é o slug do formulário, e os identificadores de opções são identificadores
de choices. Assim, você pode combinar as duas APIs: criar uma enquete com a v3 e ler as respostas
com a v4, ou o contrário. require_voter_names adiciona uma seção de dados de contato que pede um
nome.
Formulários com várias perguntas podem ser lidos pela v3, que mostra a primeira pergunta. Qualquer
alteração pela v3 é recusada com 409 unsupported_form: assim a v3 nunca exclui perguntas que não
vê. Use a v4 para esses formulários.
Configurações
poll_config | Configuração do formulário |
|---|---|
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, com comentários públicos |
allow_vpn_users | o contrário de blockVPNUsers |
force_appearance: light, dark, auto | o tema claro ou escuro do StrawPoll, ou nenhum |
is_multiple_choice, multiple_choice_min, multiple_choice_max | iguais, e 0 significa sem limite |
allow_other_option | respostas livres |
randomize_options | opções embaralhadas |
allow_indeterminate | respostas “se necessário” nas enquetes de reunião |
require_voter_names | uma pergunta de nome; sempre ativa nas enquetes de reunião |
PUT/polls/{id} mantém cada configuração que você omitir em poll_config, assim como os votos
das opções cujo id você enviar de novo.
Formulários configurados no editor podem usar verificações que a v3 não conhece. Elas aparecem com
o valor v3 mais próximo: uma verificação por nome como session, uma verificação por e-mail como invite.
As diferenças que vale a pena conhecer
- As enquetes são publicadas na hora. A v3 não tinha rascunhos. As alterações com
PUTficam no ar imediatamente; um rascunho aberto no editor não é afetado. is_privatesempre valetrue. Na nova plataforma, as enquetes nunca aparecem publicamente em listagens.- Resultados.
poll_votesvale1(escolhida ou sim),0(não escolhida ou não),2(se necessário) enull(sem resposta). Emranked_choice, é a posição que o participante deu à opção, sendo1a primeira.poll_participantsfica vazio, a menos que os nomes sejam públicos ou a enquete seja sua. Resultados que você ainda não pode ver respondem403 results_hidden. - As respostas livres aparecem como opções adicionais com
is_write_in: true. - Os comentários são notas que os participantes deixam junto com o voto. Você pode listá-los,
lê-los e (como dono da enquete) excluí-los;
POST/commentsePUT/comments/{id}respondem501. - Usuários. Não há perfis públicos:
/users/@me(ou o seu próprio id) funciona, e qualquer outro usuário retorna404.usernamevalenulleuser_metacontém apenas valores padrão.PATCH/users/@mealteradisplayname. - Mídia.
POST/uploadaceita imagens (JPEG, PNG, GIF ou WebP, até 5 MB). Vídeos e mídias do YouTube e do Giphy não são compatíveis: por issoPOST/mediaePUT/media/{id}respondem501.DELETE/media/{id}recusa imagens que uma enquete ainda exibe. - Os contadores que não existem mais, como
view_counte os pontos, valem0. - Os erros são objetos JSON com
errorecode, e valem os mesmos limites de taxa da v4.
Suas chaves atuais
As chaves da plataforma anterior continuam funcionando depois que sua conta for migrada. Você também pode criar chaves novas em Configurações → Chaves de API; elas funcionam tanto para a v3 quanto para a v4.