Skip to main content

Endpoints de l'API Omajva

Cette section décrit les principaux endpoints de l'API Omajva. Chaque requête nécessite un jeton JWT pour être authentifiée.

Endpoint 1: Health Check​

Ce endpoint permet de vérifier l'état de fonctionnement de l'API.

Requête​

  • URL : /health
  • Méthode : GET
  • Authentification : Non requise

Exemple de requête​

curl -X GET http://api.omajva.com/health

Réponse​

Code de réponse : 200 OK

Exemple de réponse :

{
  "message": "UP"
}

Endpoint 2: Traitement d'un fichier​

Ce endpoint permet d'envoyer une image pour traitement, notamment pour extraire les informations d'un type de document spécifique.

Requête​

  • URL : /omajva/process
  • Méthode : POST
  • Authentification : Requise (API Token)
  • Corps de la requête : La requête doit inclure l'image en base64 du documents à traiter.

Exemple de corps de la requête​

{
  "image": "base64_encoded_image_data"
}

Limites de requêtes​

Maximum de 10 requêtes par minute et par utilisateur. Merci de nous contacter pour augmenter ce Tier.

Exemple de requête​

curl -X POST http://api.omajva.com/omajva/process \
  -H "X-API-KEY: <token>" \
  -d '{
    "image": "iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAApgAAAKYB3X3/OAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAANCSURBVEiJtZZPbBtFFMZ/M7ubXdtdb1xSFyeilBapySVU8h8OoFaooFSqiihIVIpQBKci6KEg9Q6H9kovIHoCIVQJJCKE1ENFjnAgcaSGC6rEnxBwA04Tx43t2FnvDAfjkNibxgHxnWb2e/u992bee7tCa00YFsffekFY+nUzFtjW0LrvjRXrCDIAaPLlW0nHL0SsZtVoaF98mLrx3pdhOqLtYPHChahZcYYO7KvPFxvRl5XPp1sN3adWiD1ZAqD6XYK1b/dvE5IWryTt2udLFedwc1+9kLp+vbbpoDh+6TklxBeAi9TL0taeWpdmZzQDry0AcO+jQ12RyohqqoYoo8RDwJrU+qXkjWtfi8Xxt58BdQuwQs9qC/afLwCw8tnQbqYAPsgxE1S6F3EAIXux2oQFKm0ihMsOF71dHYx+f3NND68ghCu1YIoePPQN1pGRABkJ6Bus96CutRZMydTl+TvuiRW1m3n0eDl0vRPcEysqdXn+jsQPsrHMquGeXEaY4Yk4wxWcY5V/9scqOMOVUFthatyTy8QyqwZ+kDURKoMWxNKr2EeqVKcTNOajqKoBgOE28U4tdQl5p5bwCw7BWquaZSzAPlwjlithJtp3pTImSqQRrb2Z8PHGigD4RZuNX6JYj6wj7O4TFLbCO/Mn/m8R+h6rYSUb3ekokRY6f/YukArN979jcW+V/S8g0eT/N3VN3kTqWbQ428m9/8k0P/1aIhF36PccEl6EhOcAUCrXKZXXWS3XKd2vc/TRBG9O5ELC17MmWubD2nKhUKZa26Ba2+D3P+4/MNCFwg59oWVeYhkzgN/JDR8deKBoD7Y+ljEjGZ0sosXVTvbc6RHirr2reNy1OXd6pJsQ+gqjk8VWFYmHrwBzW/n+uMPFiRwHB2I7ih8ciHFxIkd/3Omk5tCDV1t+2nNu5sxxpDFNx+huNhVT3/zMDz8usXC3ddaHBj1GHj/As08fwTS7Kt1HBTmyN29vdwAw+/wbwLVOJ3uAD1wi/dUH7Qei66PfyuRj4Ik9is+hglfbkbfR3cnZm7chlUWLdwmprtCohX4HUtlOcQjLYCu+fzGJH2QRKvP3UNz8bWk1qMxjGTOMThZ3kvgLI5AzFfo379UAAAAASUVORK5CYII="
  }'

Réponse​

Code de réponse : 202 Accepted

Exemple de réponse :​

{
  "status": "Process in progress",
  "processing_id": "123e4567-e89b-12d3-a456-426614174000"
}

Exemple de réponse (en cas d'erreur) :​

{
  "error": "504 Gateway Time-out"
}

Code de réponse (en cas d'erreur) : 400 Bad Request, 503 Service Unavailable ou 504 Gateway Time-out

Endpoint 3: Récupérer le résultat du traitement​

Ce endpoint permet de récupérer le résultat du traitement d'une image précédemment envoyée, en utilisant l'ID de traitement fourni lors de l'envoi de l'image.

Requête​

  • URL : /omajva/result/{processing_id}
  • Méthode : GET
  • Authentification : Requise (API Token)

Exemple de requête​

curl -X GET http://api.omajva.com/omajva/result/123e4567-e89b-12d3-a456-426614174000 \
  -H "X-API-KEY: <token>"

Limites de requêtes​

Maximum de 10 requêtes par minute et par utilisateur. Merci de nous contacter pour augmenter ce Tier.

Réponse​

Code de réponse (résultat prêt) : 200 OK

Exemple de réponse :​

[
    {
        "document_type": "kbis",
        "page_index": [
            0
        ],
        "read_success": true,
        "values": {
            "ape_code": "6202A",
            "company_name": { ... }  // Données extraites du document
        }
    }
]

Exemple de réponse (résultat en cours de traitement) :​

{
  "status": "Processing",
  "message": "The result is not ready yet. Please try again later."
}

Code de réponse (erreur) : 404 Not Found ou 503 Service Unavailable

Exemple de réponse (en cas d'erreur) :​

{
  "error": "Failed to retrieve result: <détail de l'erreur>"
}

Endpoint 4: Vérification du numéro de TVA​

Ce endpoint permet de vérifier la validité d'un numéro de TVA intracommunautaire (VAT) et d'obtenir des informations sur l'entreprise associée. Il est utile pour valider les informations fiscales des clients ou fournisseurs avant de traiter des transactions commerciales.

Requête​

  • URL : /omajva/check-vat
  • Méthode : POST
  • Authentification : Requise (API Token)
  • Corps de la requête : Le numéro de TVA à vérifier doit être fourni en JSON.

Exemple de requête​

curl -X POST http://api.omajva.com/omajva/check-vat \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: <token>" \
  -d '{
    "vat_number": "FR12345678901"
  }'

Limites de requêtes​

Maximum de 10 requêtes par minute et par utilisateur. Merci de nous contacter pour augmenter ce Tier.

Réponse​

Code de réponse : 200 OK

Exemple de réponse :​

[
  {
      "valid": true,
      "countryCode": "FR",
      "vatNumber": "FR12345678901",
      "requestDate": "2024-11-13T10:41:39.741Z",
      "name": "SAS OMAJVA",
      "address": "PARC ENTREPRISE, RUE OMAJVA, 28630 THIVARS"
  }
]

Exemple de réponse (en cas d'erreur) :​

{
  "error": "504 Gateway Time-out"
}

Code de réponse (en cas d'erreur) : 400 Bad Request, 503 Service Unavailable ou 504 Gateway Time-out

Endpoint 5: Vérification d'un IBAN​

Ce endpoint permet de vérifier la validité d'un numéro IBAN en effectuant diverses validations et en retournant des informations détaillées sur l'IBAN et la banque associée.

Requête​

  • URL : /omajva/check-iban
  • Méthode : POST
  • Authentification : Requise (API Token)
  • Corps de la requête : L'image contenant le RIB doit être envoyée encodée en base64.

Exemple de requête​

curl -X POST http://api.omajva.com/omajva/check-iban \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: <token>" \
  -d '{
    "image": "<base64_encoded_image>"
  }'

Limites de requêtes​

Maximum de 10 requêtes par minute et par utilisateur. Merci de nous contacter pour augmenter ce Tier.

Réponse​

Code de réponse : 200 OK

Exemple de réponse :​

{
    "bank_detected": "Caisse D'Epargne",
    "bank_code": "13825",
    "bank_name": "caisse d'epargne et de prevoyance de rhone alpes",
    "iban_number": "FR7613825002000999999999999",
    "country": "FR",
    "score": "100%"
}

Exemple de réponse (en cas d'erreur) :​

{
  "error": "504 Gateway Time-out"
}

Code de réponse (en cas d'erreur) : 400 Bad Request, 503 Service Unavailable ou 504 Gateway Time-out