{
  "openapi": "3.1.0",
  "info": {
    "title": "API Liseuse PDF",
    "version": "1.2.0",
    "description": "Liens de lecture signés pour vos abonnés, publication de numéros, statistiques. Documentation : https://liseuse-pdf.com/docs/api",
    "contact": {
      "email": "contact@inklura.fr",
      "url": "https://liseuse-pdf.com/docs"
    }
  },
  "servers": [
    {
      "url": "https://liseuse-pdf.com/api/gestion/v1"
    }
  ],
  "security": [
    {
      "cle": []
    }
  ],
  "tags": [
    {
      "name": "Liens"
    },
    {
      "name": "Numéros"
    },
    {
      "name": "Statistiques"
    },
    {
      "name": "Compte"
    }
  ],
  "paths": {
    "/liens": {
      "post": {
        "tags": [
          "Liens"
        ],
        "summary": "Créer un lien de lecture signé",
        "description": "Permission « liens ».",
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": false,
            "schema": {
              "type": "string",
              "maxLength": 120
            },
            "description": "Même clé dans les 24 h : la première réponse est renvoyée."
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "id"
                ],
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "jours": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 365
                  },
                  "page": {
                    "type": "integer",
                    "minimum": 1
                  },
                  "reference": {
                    "type": "string",
                    "pattern": "^[A-Za-z0-9_.:@+-]{1,80}$",
                    "description": "Votre identifiant d’abonné, pour révoquer ses liens"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Lien créé",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Lien"
                }
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Erreur"
          }
        }
      }
    },
    "/liens/revoquer": {
      "post": {
        "tags": [
          "Liens"
        ],
        "summary": "Désactiver les liens d’un abonné",
        "description": "Permission « liens ».",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "reference"
                ],
                "properties": {
                  "reference": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Liens désactivés",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "reference": {
                      "type": "string"
                    },
                    "revoque_le": {
                      "type": "string",
                      "format": "date-time"
                    }
                  }
                }
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Erreur"
          }
        }
      }
    },
    "/publications": {
      "get": {
        "tags": [
          "Numéros"
        ],
        "summary": "Lister vos numéros en ligne",
        "description": "Permission « lecture ».",
        "parameters": [
          {
            "name": "publication",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limite",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 200,
              "default": 50
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Numéros",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "publications": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Numero"
                      }
                    }
                  }
                }
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Erreur"
          }
        }
      }
    },
    "/numeros": {
      "get": {
        "tags": [
          "Numéros"
        ],
        "summary": "Un numéro",
        "description": "Permission « lecture ».",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "liseuse-pdf.com:inklura-escales-n12"
          }
        ],
        "responses": {
          "200": {
            "description": "Numéro",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "numero": {
                      "$ref": "#/components/schemas/Numero"
                    }
                  }
                }
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Erreur"
          }
        }
      },
      "post": {
        "tags": [
          "Numéros"
        ],
        "summary": "Publier un numéro (PDF envoyé avec /televersements)",
        "description": "Permission « publication ».",
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": false,
            "schema": {
              "type": "string",
              "maxLength": 120
            },
            "description": "Même clé dans les 24 h : la première réponse est renvoyée."
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "sha256",
                  "taille",
                  "titre"
                ],
                "properties": {
                  "sha256": {
                    "type": "string",
                    "pattern": "^[a-f0-9]{64}$"
                  },
                  "taille": {
                    "type": "integer"
                  },
                  "titre": {
                    "type": "string",
                    "maxLength": 200
                  },
                  "publication": {
                    "type": "string"
                  },
                  "nouvelle_publication": {
                    "type": "string"
                  },
                  "parution": {
                    "type": "string",
                    "pattern": "^\\d{4}-\\d{2}$"
                  },
                  "acces": {
                    "type": "string",
                    "enum": [
                      "abonnes",
                      "libre"
                    ]
                  },
                  "lien_achat": {
                    "type": "string",
                    "format": "uri"
                  },
                  "telechargement": {
                    "type": [
                      "boolean",
                      "null"
                    ],
                    "description": "null ou absent : comme le titre"
                  },
                  "impression": {
                    "type": [
                      "boolean",
                      "null"
                    ],
                    "description": "null ou absent : comme le titre"
                  },
                  "domaine": {
                    "type": "string",
                    "enum": [
                      "liseuse-pdf.com",
                      "liseuse-pdf.fr"
                    ]
                  },
                  "adresse": {
                    "type": "string"
                  },
                  "pages": {
                    "type": "integer"
                  },
                  "nom_fichier": {
                    "type": "string"
                  },
                  "couverture_sha256": {
                    "type": "string"
                  },
                  "couverture_taille": {
                    "type": "integer"
                  },
                  "remplace": {
                    "type": "string",
                    "description": "Identifiant du numéro dont on remplace le PDF"
                  },
                  "publier_le": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Parution programmée (un an au plus)"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "PDF remplacé"
          },
          "201": {
            "description": "Numéro publié",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "numero": {
                      "$ref": "#/components/schemas/Numero"
                    },
                    "couverture": {
                      "type": "string",
                      "enum": [
                        "prete",
                        "en_preparation"
                      ]
                    }
                  }
                }
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Erreur"
          }
        }
      },
      "patch": {
        "tags": [
          "Numéros"
        ],
        "summary": "Modifier un numéro",
        "description": "Permission « publication ».",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "liseuse-pdf.com:inklura-escales-n12"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "titre": {
                    "type": "string"
                  },
                  "acces": {
                    "type": "string",
                    "enum": [
                      "abonnes",
                      "libre"
                    ]
                  },
                  "lien_achat": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "en_ligne": {
                    "type": "boolean"
                  },
                  "telechargement": {
                    "type": [
                      "boolean",
                      "null"
                    ],
                    "description": "null ou absent : comme le titre"
                  },
                  "impression": {
                    "type": [
                      "boolean",
                      "null"
                    ],
                    "description": "null ou absent : comme le titre"
                  },
                  "publication": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "publier_le": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Nouvelle date d’un numéro programmé"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Numéro modifié",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "numero": {
                      "$ref": "#/components/schemas/Numero"
                    }
                  }
                }
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Erreur"
          }
        }
      }
    },
    "/televersements": {
      "post": {
        "tags": [
          "Numéros"
        ],
        "summary": "Adresse d’envoi d’un fichier",
        "description": "Permission « publication ». Envoyez ensuite le fichier en PUT avec les en-têtes indiqués.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "sha256",
                  "taille"
                ],
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "pdf",
                      "couverture"
                    ],
                    "default": "pdf"
                  },
                  "sha256": {
                    "type": "string"
                  },
                  "taille": {
                    "type": "integer"
                  },
                  "domaine": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Fichier déjà présent (deja_present: true)"
          },
          "201": {
            "description": "Adresse d’envoi",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "deja_present": {
                      "type": "boolean"
                    },
                    "sha256": {
                      "type": "string"
                    },
                    "methode": {
                      "type": "string"
                    },
                    "url": {
                      "type": "string"
                    },
                    "en_tetes": {
                      "type": "object"
                    },
                    "expire_dans": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Erreur"
          }
        }
      }
    },
    "/statistiques": {
      "get": {
        "tags": [
          "Statistiques"
        ],
        "summary": "Lectures d’un numéro",
        "description": "Permission « lecture ».",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "liseuse-pdf.com:inklura-escales-n12"
          },
          {
            "name": "depuis",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "date"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Statistiques",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "depuis": {
                      "type": "string"
                    },
                    "lectures": {
                      "type": "integer"
                    },
                    "lectures_depuis_publication": {
                      "type": "integer"
                    },
                    "par_jour": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "jour": {
                            "type": "string"
                          },
                          "lectures": {
                            "type": "integer"
                          }
                        }
                      }
                    },
                    "temps_moyen_secondes": {
                      "type": [
                        "integer",
                        "null"
                      ]
                    },
                    "lu_jusqu_a_la_fin": {
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "sources": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "source": {
                            "type": "string"
                          },
                          "lectures": {
                            "type": "integer"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Erreur"
          }
        }
      }
    },
    "/compte": {
      "get": {
        "tags": [
          "Compte"
        ],
        "summary": "Formule, statut, limites et utilisation",
        "description": "Permission « lecture ».",
        "responses": {
          "200": {
            "description": "Compte",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "compte": {
                      "type": "object"
                    }
                  }
                }
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Erreur"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "cle": {
        "type": "http",
        "scheme": "bearer",
        "description": "Clé API lsp_… (espace éditeur › Intégrations)"
      }
    },
    "schemas": {
      "Lien": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string"
          },
          "expire_le": {
            "type": "string",
            "format": "date-time"
          },
          "iframe": {
            "type": "string"
          }
        }
      },
      "Numero": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "titre": {
            "type": "string"
          },
          "publication": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string"
              },
              "nom": {
                "type": "string"
              }
            }
          },
          "date": {
            "type": [
              "string",
              "null"
            ]
          },
          "pages": {
            "type": [
              "integer",
              "null"
            ]
          },
          "acces": {
            "type": "string",
            "enum": [
              "abonnes",
              "libre"
            ]
          },
          "page_publique": {
            "type": "string"
          },
          "lecture_libre": {
            "type": [
              "string",
              "null"
            ]
          },
          "couverture": {
            "type": [
              "string",
              "null"
            ]
          },
          "statut": {
            "type": "string",
            "enum": [
              "en_ligne",
              "programme",
              "retire"
            ],
            "description": "GET /numeros"
          },
          "publier_le": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        }
      },
      "Erreur": {
        "type": "object",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "responses": {
      "Erreur": {
        "description": "Erreur (400, 401, 402, 403, 404, 409, 413, 429)",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Erreur"
            }
          }
        }
      }
    }
  }
}