API

Reference API Struct20022

La meme API alimente l'interface web, les fichiers, les cles API et les integrations ERP. Les routes sont versionnees sous /v1.

Base URL et auth

Production
https://api.struct20022.cloud
Documentation
https://struct20022.cloud/api-reference
  • JWT Supabase : Authorization: Bearer <jwt>
  • Cle API : X-API-Key: struct20022_live_...

Options combinables

Option APINomCout maxUsage
structuringStructuration1 creditAdresse complete attendue, sans verification d'existence.
completionCompletion1 creditComplete une adresse incomplete. Un resultat partiel ou non abouti conserve la meilleure structure avec une fiabilite basse, sans debit en cas d'echec.
validationValidation1 creditSource officielle. Seulement pour les pays supportes.

Adresse unique

curl -X POST https://api.struct20022.cloud/v1/addresses/structure \
  -H "X-API-Key: struct20022_live_..." \
  -H "Content-Type: application/json" \
  -d '{"address":"12 rue de la paix, 75002 Paris","features":{"structuring":true,"completion":true,"validation":false},"country":"FR"}'

# Validation seule : structured_address complet obligatoire
curl -X POST https://api.struct20022.cloud/v1/addresses/structure \
  -H "X-API-Key: struct20022_live_..." \
  -H "Content-Type: application/json" \
  -d '{"structured_address":{"street_name":"Rue de la Paix","building_number":"12","post_code":"75002","town_name":"Paris","country":"FR"},"features":{"structuring":false,"completion":false,"validation":true}}'

Fichiers

curl -X POST https://api.struct20022.cloud/v1/files/detect-columns \
  -H "X-API-Key: struct20022_live_..." \
  -F "file=@clients.xlsx"

curl -X POST https://api.struct20022.cloud/v1/files \
  -H "X-API-Key: struct20022_live_..." \
  -F "file=@clients.xlsx" \
  -F "structuring=true" \
  -F "completion=true" \
  -F "validation=false" \
  -F "output_format=xlsx" \
  -F "output_layout=enriched"

curl https://api.struct20022.cloud/v1/jobs/<job_id> \
  -H "X-API-Key: struct20022_live_..."

Le fichier source est supprime en fin de job. Le resultat reste telechargeable selon la duree de conservation du compte, de 0 a 365 jours. Cote API, la valeur reste envoyee en heures via file_retention_hours. La validation seule sur fichier est acceptee ; les lignes non confirmees remontent en warning sans credit de validation debite.

Credits, paiements et confidentialite

curl https://api.struct20022.cloud/v1/billing/pricing

curl https://api.struct20022.cloud/v1/credits \
  -H "X-API-Key: struct20022_live_..."

curl https://api.struct20022.cloud/v1/billing/payments \
  -H "Authorization: Bearer <jwt>"

curl -X PUT https://api.struct20022.cloud/v1/legal/privacy-settings \
  -H "Authorization: Bearer <jwt>" \
  -H "Content-Type: application/json" \
  -d '{"file_retention_hours":0}'

Playground et erreurs

Le Playground dans /app/cles appelle le vrai endpoint avec la session active et affiche les champs ISO 20022.

auth_requiredOption payante ou ressource protegee sans auth.
insufficient_creditsSolde insuffisant pour le cout maximal estime.
structured_address_requiredAucune adresse exploitable n'est fournie.
validation_unsupported_countryCompat historique ; aujourd'hui renvoye comme warning.
unsupported_formatFichier hors xlsx/xls/csv/tsv/txt/xml.
api_key_expiredCle API expiree.
file_retention_ack_requiredRegle de conservation fichiers non acceptee.