Passa al contenuto principale
PDF4me APIIntegrazioniBase di conoscenzaEstensioniTester APIBlog

Leggi il codice SwissQR - Estrattore di dati di pagamento API

PDF4me Leggi il codice SwissQR consente di estrarre e leggere i codici SwissQR da PDF documenti utilizzando la tecnologia avanzata OCR e tecnologia di riconoscimento dei codici a barre. Questo API processi di servizio PDF file ed estrae informazioni di pagamento strutturate, inclusi importi, valuta, IBAN, dettagli del creditore e riferimenti di pagamento per un'elaborazione digitale dei pagamenti senza intoppi. API riceve PDF contenuto attraverso REST API chiamate, utilizzando Base64 Codifica per una trasmissione sicura. Questa soluzione è ideale per l'elaborazione delle fatture, l'integrazione con i servizi bancari, l'automazione dei pagamenti e la rendicontazione finanziaria.

Articoli correlati del blog
Non ci sono ancora post sul blog dedicati a questa funzionalità — in arrivo a breve.
Nel frattempo, dai un'occhiata al blog di PDF4me per trovare tutorial e procedure operative su tutte le piattaforme.
Visita il blog →

Autenticazione del tuo API Richiesta​

Per accedere al PDF4me REST API, ogni richiesta deve includere credenziali di autenticazione adeguate. L'autenticazione garantisce una comunicazione sicura e convalida la tua identità come utente autorizzato del REST API.

Get your api Key

Caratteristiche principali​

  • Riconoscimento del codice SwissQR: Estrai e leggi i codici SwissQR da PDF documenti utilizzando la tecnologia avanzata OCR e tecnologia di riconoscimento dei codici a barre
  • Dati strutturati sui pagamenti: Estrarre informazioni di pagamento strutturate, inclusi importi, valuta, IBANdettagli del creditore e riferimenti di pagamento
  • Standard di pagamento svizzero: Supporto per la Svizzera QR- Standard di pagamento digitale delle fatture (giugno 2020)
  • Elaborazione asincrona: Supporto per async elaborazione con polling per operazioni di lunga durata

Supporto per codici SwissQR​

IL API supporta la lettura dei codici SwissQR da PDF documenti. I codici SwissQR contengono informazioni di pagamento strutturate tra cui importo, valuta, IBANDettagli del creditore e riferimenti di pagamento. I dati estratti vengono restituiti in un formato standardizzato per l'integrazione con i sistemi di elaborazione dei pagamenti.

Endpoint API REST​

IL PDF4me REST API utilizza standard HTTP Metodi per interagire con le risorse. Tutte le operazioni di lettura del codice SwissQR vengono eseguite tramite un unico endpoint:

  • Metodo: POST
  • Punto finale: /api/v2/ReadSwissQRBill

Parametri dell'API REST​

Elenco completo dei parametri per il codice QR di Read SwissQR REST APII parametri sono organizzati per categoria per una migliore comprensione e implementazione.

Importante: I parametri contrassegnati da un asterisco (*) sono obbligatori e devono essere forniti per il API per funzionare correttamente.

Parametri richiesti​

ParametroTipoDescrizioneEsempio
docContent*Base64PDF contenuto del file codificato in Base64 contenenti codici SwissQRJVBERi...
docName*StringPDF nome del file con estensione .pdfinvoice.pdf
async*BooleanAbilita l'elaborazione asincrona. Quando true, IL API restituisce uno stato 202 e fornisce un polling URL nel Location intestazionetrue

Produzione​

IL PDF4me Leggi il codice SwissQR REST API restituisce risposte diverse a seconda della modalità di elaborazione. API rendimenti strutturati JSON dati con informazioni sul codice SwissQR.

Elaborazione sincrona (impostazione predefinita)

Quando async non è impostato o impostato su false, IL API elabora la richiesta immediatamente:

Codice di stato: 200 OK

Content-Type: application/json

Corpo della risposta:

{
  "fileName": "invoice.pdf",
  "mimeType": "application/pdf",
  "fileSize": 2456789,
  "success": true,
  "swissQrCodeData": {
    "amount": "100.00",
    "currency": "CHF",
    "iban": "CH9300762011623852957",
    "creditorName": "Swiss Company AG",
    "paymentReference": "INV-2024-001",
    "dueDate": "2024-12-31",
    "purpose": "Invoice payment"
  }
}

Campi di risposta:

  • Nome file (stringa): La PDF nome del file
  • tipo mime (corda): MIME tipo di file (application/pdf)
  • Dimensione file (numero): Dimensione del PDF file in byte
  • successo (booleano): indica se il codice SwissQR è stato letto correttamente
  • swissQrCodeData (oggetto): Informazioni di pagamento estratte dal codice SwissQR
    • quantità (stringa): Importo del pagamento
    • valuta (stringa): Codice valuta (CHF, EUR, USD)
    • stavano andando (corda): IBAN del creditore
    • Nome del creditore (stringa): Nome o società del creditore
    • riferimento pagamento (stringa): Numero di riferimento del pagamento
    • dueDate (stringa): Data di scadenza del pagamento (se disponibile)
    • scopo (stringa): Scopo o descrizione del pagamento

Esempio (JavaScript):

const response = await fetch(url, options);
const data = await response.json();
if (data.success) {
  console.log(`Amount: ${data.swissQrCodeData.amount} ${data.swissQrCodeData.currency}`);
  console.log(`IBAN: ${data.swissQrCodeData.iban}`);
}

Esempio di richiesta​

Intestazione​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Nota:

  • Ottieni il tuo API chiave dalla PDF4me Pannello di controllo
  • IL API la chiave deve essere Base64 codificato e prefissato con "Basic" nel Authorization intestazione
  • Esempio: se il tuo API la chiave è abc123, codificalo in Base64 e utilizzare Authorization: Basic YWJjMTIz

Carico utile​

Esempio:

{
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "docName": "invoice.pdf",
  "async": true
}

Esempi di codice​

IL PDF4me Leggi il codice SwissQR REST API Fornisce esempi di codice in diversi linguaggi di programmazione. Scegli il linguaggio più adatto al tuo ambiente di sviluppo:

C# CSharp) Campione

Completo C# implementazione per la lettura dei codici SwissQR da PDF Documenti:

Casi d'uso e applicazioni industriali​

Casi d'uso in ambito finanziario e bancario

  • Elaborazione delle fatture: Estrarre le informazioni di pagamento da Swiss QR fatture per l'elaborazione automatizzata dei pagamenti
  • Integrazione bancariaIntegrare la lettura dei codici SwissQR nelle applicazioni bancarie e nei sistemi di pagamento.
  • Automazione dei pagamentiSemplifica i flussi di lavoro di pagamento e riduci l'inserimento manuale dei dati.
  • Elaborazione delle fatture: Automatizzare lo svizzero QR elaborazione delle fatture e verifica dei pagamenti
  • Riconciliazione dei pagamentiAutomatizzare i processi di abbinamento e riconciliazione dei pagamenti
  • Rendicontazione finanziaria: Estrarre i dati di pagamento da Swiss QR codici per la rendicontazione e l'analisi finanziaria

Richiedi assistenza​

Get Your API KeyAPI SamplesGetting Started