API ClickBank

Ti ricordiamo che l'API ClickBank API può essere utilizzata da chi dispone di una significativa esperienza di programmazione.

L'API ClickBank API consente a una ampio gruppo di programmi di computer di accedere in modo sicuro alle informazioni del conto ClickBank su richiesta dei proprietari del conto ClickBank. Alcune delle funzioni disponibili agli utenti dell'API comprendono la possibilità di:

  • Richiedere un rimborso per l'acquisto di un cliente
  • Richiedere l'annullamento dell'acquisto di un cliente
  • Richiamare un elenco di transazioni in un conto ClickBank in un intervallo di tempo prestabilito

Le possibilità per i programmi che utilizzano l'API ClickBank sono molte e comprendono: una bacheca dove vengono illustrati i dati di ClickBank oltre ai dati dai conti con altri servizi online, uno strumento di gestione delle iscrizione, un pacchetto di dati analitici che mostra i dati relativi alle tendenze delle vendite di un conto ClickBank specifico. Grazie all'API ClickBank sono possibili tutte queste applicazioni e molte altre ancora. Inoltre ne è prevista persino la vendita nel Marketplace di ClickBank!

L'API dei servizi di ClickBank si basa su un'architettura REST e fornisce un meccanismo http affidabile e sicuro per recuperare i dati.

REST

REST è un tipo di architettura introdotta da Roy Fielding, uno dei principali autori del protocollo HTTP nella sua tesi di dottorato "Architectural Styles and the Design of Network-based Software Architectures." Un breve introduzione all'architettura REST è riportata nell'articolo di Wikipedia Representational State Transfer

Controllo della versione

La versione attuale dell'API dei servizi ClickBank è: 1.3.

Le informazioni della versione fanno parte dell'URL per accedere ai servizi. Ciò consente i seguenti vantaggi:

  • Informazioni chiare relative al tipo di versione API in uso
  • Un percorso di aggiornamento semplice da comprendere quando sono annunciate nuove versioni API

Infrastruttura

L'API del REST di ClickBank si basa su JSR-311 - L'API Java per servizi web RESTful. Si tratta di un dettaglio d'implementazione per l'API dei servizi di ClickBank, I servizi stessi si basano sul protocollo HTTP e sono agnostici all'implementazione, per cui un web client (.NET, PHP, Java, Python, Ruby, ecc.) è in grado di utilizzare i servizi.

Anche se ClickBank non consiglia degli strumenti di REST specifici per la programmazione, riteniamo che RestClient  sia molto utile per sviluppare e provare i servizi web RESTful.

Request Header

L'header dell'API dei servizi di ClickBank è formata dai parametri sicurezza, output e pagina. L'API dei servizi di ClickBank accetta soltanto parametri di query; richieste realizzate su parametri (post) in base a form sono ignorate.

Il HTTP spec indica che un URL non può essere più lungo di 2. I programmatori API devono controllare che la lunghezza dell'url rest dell'API sia inferiore a 2000 caratteri.

Certificazione

Con alcuni linguaggi di programmazione l'API dei servizi di ClickBank richiederà al tuo sistema il possesso di un certificato per il seguente dominio:

*.clickbank.com

Per ottenere il certificato, vai al seguente URL, fai doppio clic sul blocco di autenticazione nell'angolo in basso a destra del tuo browser e salva il certificato nel tuo sistema

https://api.clickbank.com/rest/1.3/orders2

Sicurezza

I metodi dell'API dei servizi di ClickBank sono sicuri e generano un codice di stato 403 [Forbidden] se si tenta l'accesso senza le credenziali giuste. L'accesso sicuro all'API prevede un parametro di header Authorization  contenente le seguenti chiavi:

  • Chiave sviluppatore - la chiave sviluppatore garantisce all'utente il ruolo "ROLE_HAS_DEVELOPER_KEY".
  • Chiave utente impiegato - la chiave impiegato garantisce all'utente il ruolo "ROLE_API_ORDER_READ" o "ROLE_API_ORDER_WRITE".

Concettualmente, la chiave sviluppatore è un token usato di solito per consentire l'accesso all'API mentre una chiave API per utente impiegato di solito è associata a un utente specifico.  Quando si crea il parametro header con entrambi i ruoli, ciascun valore deve essere separato da due punti.

Esempio:

Authorization DEV-F7F8023A486E9A9602FFDA2765E1925:API-9870acb8d96f8bd18c2eb70725b01fe4b98ece58

Alcune API dei servizi di ClickBank non hanno bisogno di tutte e due le chiavi (in particolare sandbox). La documentazione API supportata elenca i ruoli richiesti per l'accesso a un particolare servizio. Se è richiesta soltanto la chiave sviluppatore, la presenza dei due punti nell'header non è necessaria.</>

Esempio:

Authorization DEV-F7F8023A486E9A9602FFDA2765E1925

Per acquisire le chiave sviluppatore e impiegato, leggi l'articolo sull'uso di un ClickBank Master Account. Ciascuna chiave deve essere approvata, presente e attiva affinché avvenga l'autenticazione con esito positivo.

Output

L'API dei servizi di ClickBank supporta i seguenti formati di output:

  • XML
  • JSON
  • CSV (solo con API di ordini)

Richiedi il formato di output inserendo un parametro Accept nell'header http. Se si richiede un formato non supportato il server genera un codice di stato 500 [Internal Server Error].

Esempio:

Accept application/xml

Impaginazione

Per ogni chiamata di servizio l'API non restituirà più di 100 righe. Per richieste che contengono oltre 100 righe di dati, L'API restituirà le prime 100 righe con codice di stato 206 [Partial Content]. Per recuperare le pagine aggiuntive, lo sviluppatore deve includere il parametro di header Page che indica quale pagina del risultato si desidera.

Esempio:

Page 3

Dopo l'accesso all'ultima pagina, il codice di stato generato dal servizio sarà 200 [OK] e non più 206 [Partial Content].

Limiti di API ClickBank API

L'API ClickBank gestisce un gran numero di operazioni. Per proteggere il sistema dal ricevere altre operazioni che è in grado di gestire e per garantire una distribuzione equa delle risorse di sistema è necessario adottare un sistema a quote. Di seguito si riportano le nostre direttive a supporto delle Condizioni dei servizi API. Nota: Le direttive sono soggette a modifiche.

Tutte le applicazioni che rientrano in un singolo progetto condividono i limiti per progetto.

Quote API generiche:

•        25,000 richieste per conto al giorno
•        10 domande al secondo (QPS) per IP

Se si superano tali quote, l'API ClickBank genera un errore per le richieste aggiuntive: Codice di stato HTTP 403 Forbidden e un messaggio indicante che uno specifico conto dispone di quote insufficienti per procedere.

API supportate

Per la versione 1.3, sono supportate le seguenti API:

Ciascuna API ClickBank API è auto-descrittiva. Per dettagli sulla descrizione del servizio, basta accedere all'URL dell'API.

Strumenti aggiuntivi

Debugging

L'API ClickBank API fornisce un servizio web di debug [/rest/1.2/debug]. Il servizio stampa le informazioni di contesto richieste [comprese le informazioni di contesto sicurezza] che possono essere molto utili per la correzione di problematiche inerenti a REST API.

Campioni di codice

I Seguenti campioni di codice mostrano come gli sviluppatori possono utilizzare le API:

Altre domande? Invia una richiesta

0 Commenti

Accedi per aggiungere un commento.
Powered by Zendesk