Tapaya
Accettazione in presenzaGuida all'integrazioneIntegrazione API

Integrazione API

Autentichi gli esercenti per l'Accept SDK dal Suo backend.

Per consentire ai Suoi esercenti di usare il Tapaya Accept SDK, il Suo backend registra ogni esercente e richiede un token di accesso di breve durata per ogni sessione dell'SDK. Entrambe le chiamate usano il Suo Server Secret Token; per generarne uno, consulti Autenticazione della Platform API.

L'onboarding degli esercenti e il recupero dei dati di pagamento funzionano allo stesso modo per tutti i prodotti Tapaya e sono descritti nella sezione condivisa Panoramica: API di onboarding degli esercenti e Reportistica e pagamenti.

Instradamento per ambiente

L'Accept SDK instrada automaticamente le richieste in base a come è stato inizializzato:

  • Sandbox (predefinita): si connette all'ambiente sandbox all'indirizzo https://api.sandbox.tapaya.com.
  • Produzione: si connette all'ambiente di produzione all'indirizzo https://api.tapaya.com.

Autenticazione degli esercenti (integrazioni con l'Accept SDK)

Solo per integrazioni con l'Accept SDK

Salti questa sezione se controlla direttamente l'app Tapaya Terminal (intent/deeplink, senza SDK incorporato); in tal caso il merchant of record è l'account che ha effettuato l'accesso a Tapaya Terminal, e il Suo backend non autentica mai una sessione dell'esercente. Consulti Integrare senza l'SDK.

Per consentire ai Suoi esercenti di usare il Tapaya Accept SDK, deve implementare i seguenti endpoint sul Suo backend.

Registrare un nuovo esercente

Prima di poter usare l'SDK, un esercente deve essere registrato nel sistema Tapaya. Di solito ciò avviene quando un utente si registra al Suo servizio. È sufficiente registrare l'esercente una sola volta. La registrazione può essere effettuata nella Tapaya Platform UI oppure tramite l'API.

Endpoint: POST /merchant/auth/register

curl -X 'POST' 'https://api.tapaya.com/merchant/auth/register' \
-H 'Content-Type: application/json' \
-H 'Authorization: REPLACE_ME' \
-d '{
        "merchantToken": "unique_merchant_id_from_your_db",
        "merchantName": "Acme Corp",
        "email": "admin@acme.com"
    }'

Parametri:

CampoTipoObbligatorioDescrizione
merchantTokenstringUn identificatore univoco e stabile del Suo sistema (ad esempio l'ID nel database) che identifica
l'esercente. Se non viene fornito, viene generato un token casuale.
merchantNamestringNome leggibile con cui identificare l'esercente nella dashboard e nei report. Se non viene fornito,
si usa merchantToken.
emailstring✓E-mail dell'amministratore dell'esercente, usata per l'accesso e per le comunicazioni critiche.

Risposte:

CodiceDescrizione
200Esercente registrato correttamente
400Errore di convalida della richiesta
401Non autorizzato
409Conflitto: esercente già registrato

Corpo della risposta:

{
    "merchantToken": "unique_merchant_id_from_your_db"
}

Generare il token di accesso

Per consentire a un dispositivo mobile di inizializzare l'SDK per un determinato esercente, deve generare un token di accesso di breve durata. La Sua app mobile lo richiede al Suo backend, e il Suo backend lo richiede a Tapaya. Serve un token nuovo ogni volta che l'SDK viene inizializzato.

Endpoint: POST /merchant/auth/login

curl -X 'POST' 'https://api.tapaya.com/merchant/auth/login' \
-H 'Content-Type: application/json' \
-H 'Authorization: REPLACE_ME' \
-d '{
        "merchantToken": "unique_merchant_id_from_your_db",
        "allowOnboarding": true,
        "employeeEmail": "john@acme.com"
    }'

Parametri:

CampoTipoObbligatorioDescrizione
merchantTokenstring✓Identificatore dell'esercente presso l'integratore, per il quale verrà
emesso il token di autenticazione. Lo stesso usato in /auth/register.
allowOnboardingbooleantrue se l'utente può consultare e aggiornare i dati di onboarding/KYB, attivare nuovi
metodi di pagamento e accettare i Termini e condizioni per conto dell'esercente. Deve essere true alla prima chiamata per consentire
all'esercente di attivare almeno un metodo di pagamento. false se all'utente è negato l'accesso all'onboarding e può usare solo
i metodi di pagamento già configurati. Il valore predefinito è true.
employeeEmailstringE-mail del dipendente che usa il terminale.

Risposte:

CodiceDescrizione
200Accesso dell'esercente effettuato correttamente
400Errore di convalida della richiesta
401Non autorizzato
404Non trovato

Corpo della risposta:

{
    "token": "EesrFq4PUK1WxHUj93hkrKASDFp8GxJ0"
}

Passi questo token alla Sua app mobile per inizializzare l'SDK. Lo trasferisca all'app mobile in modo sicuro e lo elimini subito dopo l'uso. Il token è vincolato all'esercente identificato da merchantToken.

Avviso di sicurezza

Si assicuri di usare il merchantToken corretto quando richiede il token per l'SDK. Il Tapaya SDK usa questo token per accedere per conto dell'esercente, ottenendo l'accesso ai suoi dati e ai suoi fondi.

Manca qualcosa in questa pagina?Richieda una funzionalità. Alleghiamo questa pagina, così il team vede il contesto.