Documentation de l’API de iSignif (beta)

L’API d’iSignif à pour but d’automatiser l’envoi et le traitement de vos signification. Il vous est possible de faire toutes les actions que vous pourriez faire sur la plateforme via une REST API.

Vous pouvez vous référer à la documentation Swagger/OpenAPI à tout moment pour explorer par vous même.

Ceci est un tutoriel rapide pour explorer l’API et créer une signification sur iSignif.

Obtenir un jeton d’authentification

Afin d’intérargir avec l’API, vous devez obtenir un jeton d’authentification (JWT token) en utilisant vos propres identifiant de votre compte.

curl -X 'POST' \
  'http://localhost:3000/api/v1/tokens' \
  -H 'accept: application/json' \
  -d 'email=john@doe.fr' \
  -d 'password=banana123'
{
  "token": "eyJhbGciO....OP_si9c"
}

Le jeton d’authentification est valide pendant 24h, il devra être renouvelé ensuite. Afin de le réutiliser simplement dans ce tutoriel, je vais ici le stocker dans une variable.

export ISIGNIF_TKN="eyJhbGciO....OP_si9c"

Créer un acte

Un acte (Act) représente un regroupement de demandes de signification (Signification) auprès de différents huissiers de justice (Bailiff). Un act dépend d’un type d’acte (ActType), qui permet d’estimer le tarif.

Il vous faut donc récupérer le type d’acte correspondant le mieux à votre demande en utilisant l’endpoint GET /api/v1/act_types

curl "http://localhost:3000/api/v1/act_types"
{
  "data": [
    {
      "id": 1,
      "name": "Assignation "
    },
    {
      "id": 3,
      "name": "Déclaration d'appel"
    },
    //...snip
  ],

Maintenant nous pouvons créer un acte de type “assignation”:

curl -X 'POST' \
  'http://localhost:3000/api/v1/acts' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer $ISIGNIF_TKN" \
  -H 'Content-Type: application/json' \
  -d '{ "act_type_id": 1, "reference": "Acte demo" }'
{
  "data": {
    "id": 16,
    "advocate_id": 6,
    // snip...
  },
}

Notez l’id, il est important afin d’intergargir avec votre acte.

Il vous est maintenant possible de consulter l’acte ou de le modifier à tout moment

curl 'https://isignif.fr/api/v1/acts/16'-H "Authorization: Bearer $ISIGNIF_TKN"

Vous pouvez aussi retrouver votre acte dans la liste de vos actes

curl 'https://isignif.fr/api/v1/acts'-H "Authorization: Bearer $ISIGNIF_TKN"

Ajout de significations

Pour l’instant, notre acte n’as pas été envoyé à l’huissier de justice. Il nous faut d’abord ajouter des significations.

Pour cela, il vous suffit de spécifier un nom (name) et un code postal (zip_code). Le code postal est très important puisqu’il permet à la plateforme de trouver un huissier de justice compétent sur le territoire.

url -X 'POST' \
  'http://localhost:3000/api/v1/acts/16/significations' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo2LCJlbWFpbCI6InN1cHBvcnRAaXNpZ25pZi5mciIsImZpcnN0bmFtZSI6IkFsZXhhbmRyZSIsImxhc3RuYW1lIjoiUm91c3NlYXUiLCJleHAiOjE3MzM1MTk0MjB9.Thwb6pgmhhmzDBLYyO1Wsd7hFsFSTtEpULYr6p7LKfw' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Signification à Lyon", "zip_code": "69001" }'
{
  "data": {
    "id": 8,
    "name": "Signification à Lyon",
    "created_at": "2024-12-05T22:38:26.720+01:00",
    "updated_at": "2024-12-05T22:38:26.720+01:00",
    "bailiff_id": 77,
    "act_id": 16,
    "bailiff_comment": null,
    "zip_code": "69001",
  },
}

Vous pouvez voir qu’un huissier de justice compétent sur le code postal a été choisis automatiquement. Vous pouvez consulter ses informations

curl 'https://isignif.fr/api/v1/bailiffs/77' -H "Authorization: Bearer $ISIGNIF_TKN"
{
  "data": {
    "id": 77,
    "email": "rick@stiedemann.example",
    "address_1": "983 Voie De Bergkamen",
    "address_2": "Apt. 845",
    "zip_code": "65249",
    "town": "Reims",
    "company_name": "Giraud SCOP",
    "siret": "02651608800585",
    "phone": null,
    "firstname": "Victoire",
    "lastname": "Arnaud",
    "created_at": "2023-11-28T09:34:11.063+01:00",
    "updated_at": "2024-12-05T22:38:26.724+01:00"
  }
}

Maintenant notre acte contient des une signification, nous pouvons la retrouver facilement:

curl -X 'GET' \
  'http://localhost:3000/api/v1/acts/16/significations' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo2LCJlbWFpbCI6InN1cHBvcnRAaXNpZ25pZi5mciIsImZpcnN0bmFtZSI6IkFsZXhhbmRyZSIsImxhc3RuYW1lIjoiUm91c3NlYXUiLCJleHAiOjE3MzM1MTk0MjB9.Thwb6pgmhhmzDBLYyO1Wsd7hFsFSTtEpULYr6p7LKfw'

Ajout de fichiers à la signification

Avant de confirmer la signification, vous devriez ajouter les documents nécessaires pour que l’huissier de justice puisse signifier cet acte.

curl -X 'POST' \
  'https://isignif.fr/api/v1/acts/16/act_files' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer $ISIGNIF_TKN" \
  -H 'Content-Type: multipart/form-data' \
  -F 'name=Document à signifier' \
  -F 'files=@/tmp/doc.pdf'

Le fichier est désormais stocké sur iSignif et vous pouvez le télécharger si besoin.

curl 'https://isignif.fr/api/v1/acts/16/act_files/3' -H "Authorization: Bearer $ISIGNIF_TKN"

Confirmation de l’acte

Jusqu’à présent, l’acte est mode “brouillon”. Vous devez le confirmer afin que les huissiers de justice affectés aux significations de l’acte soit contacté.

curl -X 'POST' 'https://isignif.fr/api/v1/acts/16/confirm' -H "Authorization: Bearer $ISIGNIF_TKN"

Et voilà. Les huissiers vont prendre connaissance de cet acte et le traiter dans les plus brefs délais.

Contacter les huissiers via la messageries

Si vous avez des demandes ou des questions particulières à transmettre à l’huissier de justice qui prend en charge votre signification, vous pouvez lui envoyer un message via notre messagerie.

curl -X 'POST' \
  'https://isignif.fr/api/v1/acts/16/significations/8/messages' \
  -H "Authorization: Bearer $ISIGNIF_TKN" \
  -d 'content=Bonjour'

Remarques

N’hésitez pas à nous contacter si vous avez des questions correspondant l’utilisation de l’API.

Vous pouvez aussi consulter la documentation Swagger/OpenAPI qui documente tous les endpoints disponible via l’API.