Supprimer un document via notre API

Bibliothèques

À ce jour, nous mettons à disposition les bibliothèques suivantes :

Authentification

Pour générer une document via l’API, vous aurez besoin d’une CLÉ d’API.

Visitez la page Mon compte grâce au menu en haut à droite.

Affichez votre CLÉ D’API en cliquant sur le lien Afficher la valeur en dessous du champ CLÉ SECRÈTE et copiez-la.

Vous pouvez utiliser cette clé pour authentifier vos appels d’API :

# Méthode 1 : Utilisez la variable d’environment PDFMONKEY_PRIVATE_KEY.
# Aucun code nécessaire.

# Méthode 2 : Réglez la clef privée manuellement
# (ce code sera généralement dans un initializer)
Pdfmonkey.configure do |config|
  config.private_key = '[CLÉ D’API]'
end
curl 'https://api.pdfmonkey.io/api/v1/documents' \
  -H 'Authorization: Bearer [CLÉ D’API]'

Supprimer un document

Voici un exemple de code permettant de supprimer un document :

document_id = '[ID DOCUMENT]'

# Supprimer directement un Document

Pdfmonkey::Document.delete(document_id)
#=> true

# Supprimer un Document après l'avoir récupéré

document = Pdfmonkey::Document.fetch(document_id)
document.delete!
#=> true
curl 'https://api.pdfmonkey.io/api/v1/documents/[ID DOCUMENT]' \
  -X DELETE \
  -H 'Authorization: Bearer [CLÉ D’API]'

Veillez à bien remplacer [CLÉ D’API] et [ID DOCUMENT] par les valeurs correspondantes.