Saltar al contingut principal
POST
cURL
Utilitza aquest endpoint per crear qüestionaris simples a través de l’API. Envia un array form_elements en l’ordre en què els usuaris han de respondre les preguntes. Didit construeix per a tu el graf intern del qüestionari. L’API només admet qüestionaris lineals simples. No enviïs graph, branches, next ni regles condicionals.

Camps obligatoris

  • title és el nom intern del qüestionari.
  • languages ha d’incloure en.
  • form_elements ha de contenir almenys una pregunta.
  • Cada element de formulari necessita un element_type i una label traduïda.
També pots afegir a un element de formulari una description traduïda opcional, com a text d’ajuda. S’accepta en tots els tipus d’element, excepte separator, i es retorna com a description de l’element a l’informe del qüestionari.

Tipus d’element

Utilitza valors en minúscules, com ara short_text, multiple_choice, email, file_upload o date_picker. També s’accepten valors d’enumeració en majúscules, com SHORT_TEXT. Per a dropdown, single_choice i multiple_choice, afegeix options. Si omets el value d’una opció, Didit en genera un a partir de l’etiqueta.

Validació de camps

Afegeix un objecte validation opcional a un element short_text, long_text o number per imposar un format a la resposta de l’usuari. És útil per a identificadors amb formats estrictes, com ara identificadors fiscals, identificadors nacionals o números de targeta. La validació s’executa mentre l’usuari omple el camp (l’usuari no pot continuar fins que la validació sigui correcta) i l’API la torna a aplicar en enviar el formulari.
La resposta inclou questionnaire_id. Guarda’l, perquè l’utilitzaràs com a questionnaire_uuid quan afegeixis el qüestionari a un flux de treball.

Autoritzacions

x-api-key
string
header
requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Cos

application/json

Crea un qüestionari lineal simple. L'API converteix form_elements en el graf intern del qüestionari.

title
string
requerit

Nom intern del qüestionari.

languages
string[]
requerit

Idiomes inclosos a cada etiqueta. Ha d'incloure en.

Exemple:
form_elements
object[]
requerit

Preguntes en l'ordre exacte en què els usuaris les haurien de veure. Les branques i els camps condicionals no són compatibles.

Minimum array length: 1
description
string | null
default_language
string

Idioma predeterminat. S'ha d'incloure a languages.

Exemple:

"en"

is_active
boolean
predeterminat:true
status
enum<string>

Omet aquest camp per crear un qüestionari publicat a punt per a fluxos de treball.

Opcions disponibles:
draft,
published

Resposta

Qüestionari creat. La resposta inclou el questionnaire_id — desa'l per fer referència a aquest qüestionari des de fluxos de treball o futures crides d'actualització/eliminació.

Detall complet del qüestionari retornat des dels endpoints GET, POST (creació) i PATCH (actualització).

questionnaire_id
string<uuid>

Identificador únic del qüestionari. Utilitza aquest id en fer referència al qüestionari des d'un flux de treball o en sol·licituds posteriors d'actualització o supressió.

title
string
description
string | null
languages
string[]
default_language
string
is_active
boolean
is_simple_questionnaire
boolean
graph
object

Estructura del graf amb start_node i mapa de nodes.

sections
object[]

Contingut del qüestionari agrupat en seccions (derivat del graf).

questionnaire_group_id
string<uuid>

Identificador estable que agrupa totes les versions del mateix qüestionari.

version
integer
status
enum<string>
Opcions disponibles:
draft,
published
published_at
string<date-time> | null
is_editable
boolean

Cert quan el qüestionari encara es pot editar in situ (versions en esborrany).

Darrera modificació el 7 de novembre del 2026