Référence API
API : ping
1 opérations REST du groupe ping.
GET /ping#
Smoke-test intégrateur - contexte du token présenté
Retourne l'app authentifiée, son user d'intégration et les scopes du token. Premier appel à faire pour vérifier une intégration de bout en bout.
Scopes d'app : voir sécurité de l’opération. Les autres droits, périmètres et contrôles métier restent applicables.
Aucun corps de requête déclaré dans ce contrat.
Réponses
200 : Contexte de l'app authentifiée
Contenu de la réponse 200
{
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"const": true
},
"appName": {
"type": "string"
},
"integrationUser": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
}
},
"required": [
"id",
"name",
"email"
],
"additionalProperties": false
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"referentials:read",
"referentials:write",
"companies:read",
"companies:write",
"contacts:read",
"contacts:write",
"products:read",
"products:write",
"quotes:read",
"quotes:write",
"invoices:read",
"invoices:write",
"requests:read",
"requests:write",
"sales_activities:read",
"sales_activities:write",
"signatures:read",
"signatures:write",
"webhooks:manage",
"exports:read",
"users:read",
"users:write",
"marketing:read",
"marketing:write",
"documents:read",
"settings:write"
]
}
}
},
"required": [
"ok",
"appName",
"integrationUser",
"scopes"
],
"additionalProperties": false
}
}
}default : Erreur - enveloppe problem+json (RFC 9457)
Contenu de la réponse default
{
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}Opération OpenAPI complète
{
"summary": "Smoke-test intégrateur - contexte du token présenté",
"description": "Retourne l'app authentifiée, son user d'intégration et les scopes du token. Premier appel à faire pour vérifier une intégration de bout en bout.",
"tags": [
"Diagnostic"
],
"security": [
{
"oauth2": []
},
{
"userSession": []
}
],
"responses": {
"200": {
"description": "Contexte de l'app authentifiée",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"const": true
},
"appName": {
"type": "string"
},
"integrationUser": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
}
},
"required": [
"id",
"name",
"email"
],
"additionalProperties": false
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"referentials:read",
"referentials:write",
"companies:read",
"companies:write",
"contacts:read",
"contacts:write",
"products:read",
"products:write",
"quotes:read",
"quotes:write",
"invoices:read",
"invoices:write",
"requests:read",
"requests:write",
"sales_activities:read",
"sales_activities:write",
"signatures:read",
"signatures:write",
"webhooks:manage",
"exports:read",
"users:read",
"users:write",
"marketing:read",
"marketing:write",
"documents:read",
"settings:write"
]
}
}
},
"required": [
"ok",
"appName",
"integrationUser",
"scopes"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "Erreur - enveloppe problem+json (RFC 9457)",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}