Documentació de l’API d’arText
Envia un text i rep un informe estructurat amb les mètriques calculades, els problemes lingüístics trobats i, quan n’hi ha, substitucions o canvis aplicables.
El gènere triat decideix què es revisa: cadascun té la seva selecció de regles, els seus llindars i els seus glossaris. No s’envien metric_id a POST /v1/reports; només cal indicar l’àmbit i el tipus de text.
Flux d’integració
Tria del gènere
GET /v1/text-types retorna els àmbits amb els seus tipus de text; cadascun porta a report_defaults el parell que cal reenviar.
Creació de l’informe
S’envia el text, l’idioma i el gènere (domain_slug + text_type_slug); l’API respon 202 amb status_url.
Espera del resultat
Mitjançant SSE o consultant status_url conforme a Retry-After fins a completed o failed.
Consum de l’informe
Mètriques, problemes, fragments i canvis disponibles en un JSON estable, amb el gènere aplicat declarat a la resposta.
Àmbits i gèneres
El catàleg té dos nivells. Triar bé el gènere és la decisió que més afecta el resultat: determina què es revisa i amb quina exigència.
Àmbit (domain_slug)
La matèria: medicina, administració pública, turisme, àmbit acadèmic o llenguatge planer. Agrupa gèneres que comparteixen matèria i, quan escau, glossaris.
Gènere (text_type_slug)
El tipus de text concret dins d’aquest àmbit: una història clínica, una al·legació, un text mèdic. És el que s’analitza.
Cada gènere porta la seva selecció de regles, els seus llindars i els seus glossaris, definits per l’equip lingüístic. Dos gèneres del mateix àmbit es poden revisar de manera diferent: una història clínica no es jutja amb els criteris d’un text mèdic. Per això el parell no és una etiqueta descriptiva, sinó la configuració amb què s’analitza el text. Per saber amb què es revisarà un gènere abans d’enviar res: GET /v1/metrics amb aquest parell retorna les regles actives i els seus llindars, i GET /v1/text-types/{domain_slug}/{text_type_slug}/glossaries diu quantes entrades aplica cada glossari i de quin nivell de la cascada surten (gènere, àmbit o idioma).
Seccions d’aquesta documentació
Autenticació
Les integracions directes requereixen una clau activa. Envia-la a la capçalera Authorization i no la incloguis en codi públic ni en aplicacions client.
Authorization: Bearer art_live_…
Com s’aconsegueix l’accés
L’API no s’autoserveix: no hi ha registre públic. L’accés es concedeix com a compte d’integració, en tres passos.
- 1
Sol·licitud
Pel formulari de contacte de la portada, indicant què es vol integrar.
- 2
Alta del compte
L’equip el crea i la invitació arriba per correu, on s’estableix la contrasenya.
- 3
Claus
Cada compte emet i revoca les seves des del seu portal. El valor d’una clau es mostra una sola vegada, en crear-la.