Vérifier un import, sans rien écrire

curl --request POST \
--url https://api.arquos.eu/api/v2/imports/check \
--header 'Authorization: Bearer arq_agent_VOTRE_JETON' \
--header 'Content-Type: application/json' \
--data '{
"fileId": "3f1c2b9e-8a4d-4c1e-9b7a-2d5e6f708192",
"object": "clients"
}'

{
"file": "texte",
"mapping": {},
"arquosColumns": [
  {
    "column": "texte",
    "required": true
  }
],
"rows": 1,
"ready": 1,
"toFix": [
  {}
]
}

curl --request POST \
--url https://api.arquos.eu/api/v2/imports/check \
--header 'Authorization: Bearer arq_agent_VOTRE_JETON' \
--header 'Content-Type: application/json' \
--data '{
"fileId": "3f1c2b9e-8a4d-4c1e-9b7a-2d5e6f708192",
"object": "clients"
}'

{
"file": "texte",
"mapping": {},
"arquosColumns": [
  {
    "column": "texte",
    "required": true
  }
],
"rows": 1,
"ready": 1,
"toFix": [
  {}
]
}

Endpoint & Authentification

Méthode	URL
`POST`	`https://api.arquos.eu/api/v2/imports/check`

En-têtes (Headers) :

Authorization: Bearer [VOTRE_JETON_D_API]
X-Arquos-Agency: [IDENTIFIANT_D_AGENCE] (facultatif, voir Agence)
Content-Type: application/json

Paramètres de la requête

string

L’identifiant de l’agence où agir. Absent : l’agence par défaut du compte. Une agence hors de sa portée est refusée (403).

string

required

L’identifiant du fichier joint.

string

required

Ce que le tableau contient : clients, immeubles (buildings), contacts ou équipements (equipment). Valeurs possibles : clients, buildings, contacts, equipment.

object

Facultatif : colonne du fichier → colonne d’Arquos.

Réponse (`200`)

string

Le nom du fichier vérifié.

object

Pour chaque colonne d’Arquos, la colonne du fichier qui la remplit.

object[]

Les colonnes du format.

Show Chaque élément

string

L’en-tête attendu.

boolean

Sans elle, la ligne est refusée.

integer

Le nombre de lignes lues.

integer

Celles qui s’importeront telles quelles.

object[]

Les lignes à corriger. L’import n’écrit rien tant qu’il en reste une.

Les erreurs

Code	Quand
`400`	Requête mal formée ou champ obligatoire manquant.
`401`	Jeton absent, inconnu ou révoqué.
`403`	Agence hors de votre portée.
`404`	Objet introuvable dans vos agences.
`429`	Trop d’appels : réessayez après le délai de l’en-tête Retry-After.

Le corps d’une erreur porte error, sa raison en français. Voir Les erreurs.

curl --request POST \
--url https://api.arquos.eu/api/v2/imports/check \
--header 'Authorization: Bearer arq_agent_VOTRE_JETON' \
--header 'Content-Type: application/json' \
--data '{
"fileId": "3f1c2b9e-8a4d-4c1e-9b7a-2d5e6f708192",
"object": "clients"
}'

{
"file": "texte",
"mapping": {},
"arquosColumns": [
  {
    "column": "texte",
    "required": true
  }
],
"rows": 1,
"ready": 1,
"toFix": [
  {}
]
}

Démarrer

API REST

Centres d'appels

Agents IA

Référence · Compte

Référence · Recherche

Référence · Équipements

Référence · Relevés

Référence · Contrats

Référence · Import

Référence · Webhooks

Référence · Référentiels

Référence · Affaires

Référence · Appels

Référence · Visites

Référence · Techniciens

Référence · Pièces

Référence · Devis

Référence · Notes

Référence · Écarts et réserves

Référence · Factures

Référence · Clients

Référence · Immeubles

Référence · Contacts

Référence · Secteurs

Référence · Campagnes

Référence · Contrôles techniques

Référence · Sollicitations

Vérifier un import, sans rien écrire

Endpoint & Authentification

Paramètres de la requête

Réponse (`200`)

Les erreurs

​Endpoint & Authentification

​Paramètres de la requête

​Réponse (200)

​Les erreurs

Endpoint & Authentification

Paramètres de la requête

Réponse (`200`)

Les erreurs