Authentication

🚧

Your credentials carry many privileges, so keep them secure! Never share your credential keys in publicly accessible areas such as GitHub, client-side code or similar locations.

Follow these three steps to get started with Sqala API:

Step 1. Request your Credentials

Get your credentials from the developer area in our portal. Access it through the user menu in the top left corner of our dashboard or directly via this URL. Use your AppID as the username and AppSecret as the password when making API requests. 👇

Step 2. Create an Access Token

📘

All API requests must use HTTPS. Requests made over plain HTTP or without authentication will fail.

JavaScript

import fetch from 'node-fetch'
import { encode } from 'base-64'

const response = await fetch('https://api.sqala.tech/core/v1/access-tokens', {
    headers: { 
      'Authorization': 'Basic ' + encode('YOUR_APP_ID' + ':' + 'YOUR_APP_SECRET'),
      'Content-Type': 'application/json'
    },
    method: 'POST',
    body: JSON.stringify({
        'refreshToken': 'YOUR_REFRESH_TOKEN'
    })
})

const data = await response.json()

console.log(data)

output

JSON

{
  "token": "eyJraWQiOiJwb1NPeDI0VHRmbDZCYjdaZ3RcL296WGpqUzMrTVlkYTNScXdON1dVSXJkbz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIyZjE5MDk0Mi1jMjY5LTQxMjQtOTNkNy01YTdmYTkwMTQ0YzkiLCJpc3MiOiJodHRwczpcL1wvY29nbml0by1pZHAuc2EtZWFzdC0xLmFtYXpvbmF3cy5jb21cL3NhLWVhc3QtMV82eWdMcFJLMGUiLCJjbGllbnRfaWQiOiIyNXQwOGxwaHYwN2IzZnZqZ2FqcTNsczFrcCIsIm9yaWdpbl9qdGkiOiIzZWZjODY1Yi01MzU2LTQwNWMtOTQxYy1iNmExM2I3ODFhNWYiLCJldmVudF9pZCI6ImMyMTM1NjgzLWY3YTUtNGMxYy04MzUzLWM3MTUyNmQ2NDU5YyIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiYXdzLmNvZ25pdG8uc2lnbmluLnVzZXIuYWRtaW4iLCJhdXRoX3RpbWUiOjE2NTQ4MTY3OTgsImV4cCI6MTY1NDgyMDUyNCwiaWF0IjoxNjU0ODE2OTI0LCJqdGkiOiI2ZmVhODZiNC1kNDVmLTRhOGQtYjEwYi1iOWRhNzkzODQyZmQiLCJ1c2VybmFtZSI6ImNhcmxvc3BlY2FuaGEyQG91dGxvb2suY29tIn0.PfKd8rpnq9xPO3IwSRkDuBDx0VjN41ABKvm0xIybNCxWh5N1b7HZsTPxjh6GiDoHWYnr8_HCzXqk0MQXYHt7ybHKIFPKqOaA4VpBrb-WaazwSAGdTJFt3grZb4KP-ab2gKaYMji9x1l_SDAaEU-frEHErOnJwyMPi1dn2pZAKJMp4p7IIctwYTFITokP4Lqn7amy_PHlsXoNlUPV0BoNBrFFq-sp22NXSdDtIsdSkyRlGqlOHNTd2zMNqqKCFx3lBt1dPfm6gPvx_mwlOiT0icAXwUOsXxi22P5HgEoh3HJw2NneP9xC8Mw1BQvhBdmfnmANQzIHWkFfBMCQo3xF5w",
  "expiresIn": 3600,
  "type": "Bearer"
}

Step 3. Create your first pix payment 💰

📘

The amount is defined in cents. eg:. 1 real must be sent as 100 in the amount field

JavaScript

import fetch from 'node-fetch'

const response = await fetch('https://api.sqala.tech/core/v1/pix-qrcode-payments', {
    headers: { 
      'Authorization': 'Bearer ' + 'YOUR_ACCESS_TOKEN',
      'Content-Type': 'application/json'
    },
    method: 'POST',
    body: JSON.stringify({
        amount: 100
    })
})